Class: Google::Cloud::Dataplex::V1::Environment

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/analyze.rb

Overview

Environment represents a user-visible compute infrastructure for analytics within a lake.

Defined Under Namespace

Classes: Endpoints, InfrastructureSpec, LabelsEntry, SessionSpec, SessionStatus

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Environment creation time.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. Description of the environment.

Returns:

  • (::String) —

    Optional. Description of the environment.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Optional. User friendly display name.

Returns:

  • (::String) —

    Optional. User friendly display name.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#endpoints ⇒ ::Google::Cloud::Dataplex::V1::Environment::Endpoints (readonly)

Returns Output only. URI Endpoints to access sessions associated with the Environment.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#infrastructure_spec ⇒ ::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec

Returns Required. Infrastructure specification for the Environment.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. User defined labels for the environment.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User defined labels for the environment.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.

Returns:

  • (::String) —

    Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#session_spec ⇒ ::Google::Cloud::Dataplex::V1::Environment::SessionSpec

Returns Optional. Configuration for sessions created for this environment.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#session_status ⇒ ::Google::Cloud::Dataplex::V1::Environment::SessionStatus (readonly)

Returns Output only. Status of sessions created for this environment.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#state ⇒ ::Google::Cloud::Dataplex::V1::State (readonly)

Returns Output only. Current state of the environment.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.

Returns:

  • (::String) —

    Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the environment was last updated.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/dataplex/v1/analyze.rb', line 66

class Environment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for the underlying infrastructure used to run workloads.
  # @!attribute [rw] compute
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::ComputeResources]
  #     Optional. Compute resources needed for analyze interactive workloads.
  # @!attribute [rw] os_image
  #   @return [::Google::Cloud::Dataplex::V1::Environment::InfrastructureSpec::OsImageRuntime]
  #     Required. Software Runtime Configuration for analyze interactive
  #     workloads.
  class InfrastructureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Compute resources associated with the analyze interactive workloads.
    # @!attribute [rw] disk_size_gb
    #   @return [::Integer]
    #     Optional. Size in GB of the disk. Default is 100 GB.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     Optional. Total number of nodes in the sessions created for this
    #     environment.
    # @!attribute [rw] max_node_count
    #   @return [::Integer]
    #     Optional. Max configurable nodes.
    #     If max_node_count > node_count, then auto-scaling is enabled.
    class ComputeResources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Software Runtime Configuration to run Analyze.
    # @!attribute [rw] image_version
    #   @return [::String]
    #     Required. Dataplex Image version.
    # @!attribute [rw] java_libraries
    #   @return [::Array<::String>]
    #     Optional. List of Java jars to be included in the runtime environment.
    #     Valid input includes Cloud Storage URIs to Jar binaries.
    #     For example, gs://bucket-name/my/path/to/file.jar
    # @!attribute [rw] python_packages
    #   @return [::Array<::String>]
    #     Optional. A list of python packages to be installed.
    #     Valid formats include Cloud Storage URI to a PIP installable library.
    #     For example, gs://bucket-name/my/path/to/lib.tar.gz
    # @!attribute [rw] properties
    #   @return [::Google::Protobuf::Map{::String => ::String}]
    #     Optional. Spark properties to provide configuration for use in sessions
    #     created for this environment. The properties to set on daemon config
    #     files. Property keys are specified in `prefix:property` format. The
    #     prefix must be "spark".
    class OsImageRuntime
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::String]
      class PropertiesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Configuration for sessions created for this environment.
  # @!attribute [rw] max_idle_duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. The idle time configuration of the session. The session will be
  #     auto-terminated at the end of this period.
  # @!attribute [rw] enable_fast_startup
  #   @return [::Boolean]
  #     Optional. If True, this causes sessions to be pre-created and available
  #     for faster startup to enable interactive exploration use-cases. This
  #     defaults to False to avoid additional billed charges. These can only be
  #     set to True for the environment with name set to "default", and with
  #     default configuration.
  class SessionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of sessions created for this environment.
  # @!attribute [r] active
  #   @return [::Boolean]
  #     Output only. Queries over sessions to mark whether the environment is
  #     currently active or not
  class SessionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # URI Endpoints to access sessions associated with the Environment.
  # @!attribute [r] notebooks
  #   @return [::String]
  #     Output only. URI to serve notebook APIs
  # @!attribute [r] sql
  #   @return [::String]
  #     Output only. URI to serve SQL APIs
  class Endpoints
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end