google-cloud-dataplex-v1 0.3.0 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -34,9 +34,9 @@ module Google
34
34
  ##
35
35
  # Dataplex service provides data lakes as a service. The primary resources
36
36
  # offered by this service are Lakes, Zones and Assets which collectively allow
37
- # a data adminstrator to organize, manage, secure and catalog data across their
38
- # organization located across cloud projects in a variety of storage systems
39
- # including Cloud Storage and BigQuery.
37
+ # a data administrator to organize, manage, secure and catalog data across
38
+ # their organization located across cloud projects in a variety of storage
39
+ # systems including Cloud Storage and BigQuery.
40
40
  #
41
41
  # To load this service and instantiate a client:
42
42
  #
@@ -33,6 +33,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
33
33
  optional :partition, :string, 1
34
34
  optional :entity, :string, 2
35
35
  optional :type, :enum, 3, "google.cloud.dataplex.v1.DiscoveryEvent.EntityType"
36
+ repeated :sampled_data_locations, :string, 4
36
37
  end
37
38
  add_message "google.cloud.dataplex.v1.DiscoveryEvent.ActionDetails" do
38
39
  optional :type, :string, 1
@@ -18,6 +18,8 @@
18
18
 
19
19
  require "google/cloud/errors"
20
20
  require "google/cloud/dataplex/v1/metadata_pb"
21
+ require "google/cloud/location"
22
+ require "google/iam/v1/iam_policy"
21
23
 
22
24
  module Google
23
25
  module Cloud
@@ -164,6 +166,18 @@ module Google
164
166
  @quota_project_id = @config.quota_project
165
167
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
166
168
 
169
+ @location_client = Google::Cloud::Location::Locations::Client.new do |config|
170
+ config.credentials = credentials
171
+ config.quota_project = @quota_project_id
172
+ config.endpoint = @config.endpoint
173
+ end
174
+
175
+ @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
176
+ config.credentials = credentials
177
+ config.quota_project = @quota_project_id
178
+ config.endpoint = @config.endpoint
179
+ end
180
+
167
181
  @metadata_service_stub = ::Gapic::ServiceStub.new(
168
182
  ::Google::Cloud::Dataplex::V1::MetadataService::Stub,
169
183
  credentials: credentials,
@@ -173,6 +187,20 @@ module Google
173
187
  )
174
188
  end
175
189
 
190
+ ##
191
+ # Get the associated client for mix-in of the Locations.
192
+ #
193
+ # @return [Google::Cloud::Location::Locations::Client]
194
+ #
195
+ attr_reader :location_client
196
+
197
+ ##
198
+ # Get the associated client for mix-in of the IAMPolicy.
199
+ #
200
+ # @return [Google::Iam::V1::IAMPolicy::Client]
201
+ #
202
+ attr_reader :iam_policy_client
203
+
176
204
  # Service calls
177
205
 
178
206
  ##
@@ -376,7 +404,8 @@ module Google
376
404
  # Required. The resource name of the entity:
377
405
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
378
406
  # @param etag [::String]
379
- # Required. The etag associated with the partition if it was previously retrieved.
407
+ # Required. The etag associated with the entity, which can be retrieved with a
408
+ # [GetEntity][] request.
380
409
  #
381
410
  # @yield [response, operation] Access the result along with the RPC operation
382
411
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -570,8 +599,8 @@ module Google
570
599
  # - Entity ID: ?filter="id=entityID"
571
600
  # - Asset ID: ?filter="asset=assetID"
572
601
  # - Data path ?filter="data_path=gs://my-bucket"
573
- # - Is HIVE compatible: ?filter=”hive_compatible=true
574
- # - Is BigQuery compatible: ?filter=”bigquery_compatible=true
602
+ # - Is HIVE compatible: ?filter="hive_compatible=true"
603
+ # - Is BigQuery compatible: ?filter="bigquery_compatible=true"
575
604
  #
576
605
  # @yield [response, operation] Access the result along with the RPC operation
577
606
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Entity>]
@@ -760,7 +789,7 @@ module Google
760
789
  # The \\{partition_value_path} segment consists of an ordered sequence of
761
790
  # partition values separated by "/". All values must be provided.
762
791
  # @param etag [::String]
763
- # Optional. The etag associated with the partition if it was previously retrieved.
792
+ # Optional. The etag associated with the partition.
764
793
  #
765
794
  # @yield [response, operation] Access the result along with the RPC operation
766
795
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -945,14 +974,14 @@ module Google
945
974
  # provided to `ListPartitions` must match the call that provided the
946
975
  # page token.
947
976
  # @param filter [::String]
948
- # Optional. Filter the partitions returned to the caller using a key vslue pair
949
- # expression. The filter expression supports:
977
+ # Optional. Filter the partitions returned to the caller using a key value pair
978
+ # expression. Supported operators and syntax:
950
979
  #
951
- # - logical operators: AND, OR
980
+ # - logic operators: AND, OR
952
981
  # - comparison operators: <, >, >=, <= ,=, !=
953
982
  # - LIKE operators:
954
- # - The right hand of a LIKE operator supports “.” and
955
- # “*” for wildcard searches, for example "value1 LIKE ".*oo.*"
983
+ # - The right hand of a LIKE operator supports "." and
984
+ # "*" for wildcard searches, for example "value1 LIKE ".*oo.*"
956
985
  # - parenthetical grouping: ( )
957
986
  #
958
987
  # Sample filter expression: `?filter="key1 < value1 OR key2 > value2"
@@ -206,6 +206,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
206
206
  optional :parent, :string, 1
207
207
  optional :page_size, :int32, 2
208
208
  optional :page_token, :string, 3
209
+ optional :filter, :string, 4
209
210
  end
210
211
  add_message "google.cloud.dataplex.v1.ListSessionsResponse" do
211
212
  repeated :sessions, :message, 1, "google.cloud.dataplex.v1.Session"
@@ -26,9 +26,9 @@ module Google
26
26
  module DataplexService
27
27
  # Dataplex service provides data lakes as a service. The primary resources
28
28
  # offered by this service are Lakes, Zones and Assets which collectively allow
29
- # a data adminstrator to organize, manage, secure and catalog data across their
30
- # organization located across cloud projects in a variety of storage systems
31
- # including Cloud Storage and BigQuery.
29
+ # a data administrator to organize, manage, secure and catalog data across
30
+ # their organization located across cloud projects in a variety of storage
31
+ # systems including Cloud Storage and BigQuery.
32
32
  class Service
33
33
 
34
34
  include ::GRPC::GenericService
@@ -22,6 +22,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
22
22
  map :labels, :string, :string, 8
23
23
  optional :trigger_spec, :message, 100, "google.cloud.dataplex.v1.Task.TriggerSpec"
24
24
  optional :execution_spec, :message, 101, "google.cloud.dataplex.v1.Task.ExecutionSpec"
25
+ optional :execution_status, :message, 201, "google.cloud.dataplex.v1.Task.ExecutionStatus"
25
26
  oneof :config do
26
27
  optional :spark, :message, 300, "google.cloud.dataplex.v1.Task.SparkTaskConfig"
27
28
  end
@@ -42,6 +43,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
42
43
  optional :max_executors_count, :int32, 2
43
44
  end
44
45
  add_message "google.cloud.dataplex.v1.Task.InfrastructureSpec.ContainerImageRuntime" do
46
+ optional :image, :string, 1
45
47
  repeated :java_jars, :string, 2
46
48
  repeated :python_packages, :string, 3
47
49
  map :properties, :string, :string, 4
@@ -70,7 +72,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
70
72
  add_message "google.cloud.dataplex.v1.Task.ExecutionSpec" do
71
73
  map :args, :string, :string, 4
72
74
  optional :service_account, :string, 5
75
+ optional :project, :string, 7
73
76
  optional :max_job_execution_lifetime, :message, 8, "google.protobuf.Duration"
77
+ optional :kms_key, :string, 9
74
78
  end
75
79
  add_message "google.cloud.dataplex.v1.Task.SparkTaskConfig" do
76
80
  repeated :file_uris, :string, 3
@@ -84,6 +88,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
84
88
  optional :sql_script, :string, 105
85
89
  end
86
90
  end
91
+ add_message "google.cloud.dataplex.v1.Task.ExecutionStatus" do
92
+ optional :update_time, :message, 3, "google.protobuf.Timestamp"
93
+ optional :latest_job, :message, 9, "google.cloud.dataplex.v1.Job"
94
+ end
87
95
  add_message "google.cloud.dataplex.v1.Job" do
88
96
  optional :name, :string, 1
89
97
  optional :uid, :string, 2
@@ -124,6 +132,7 @@ module Google
124
132
  Task::TriggerSpec::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Task.TriggerSpec.Type").enummodule
125
133
  Task::ExecutionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Task.ExecutionSpec").msgclass
126
134
  Task::SparkTaskConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Task.SparkTaskConfig").msgclass
135
+ Task::ExecutionStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Task.ExecutionStatus").msgclass
127
136
  Job = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Job").msgclass
128
137
  Job::Service = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Job.Service").enummodule
129
138
  Job::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataplex.v1.Job.State").enummodule
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dataplex
23
23
  module V1
24
- VERSION = "0.3.0"
24
+ VERSION = "0.4.0"
25
25
  end
26
26
  end
27
27
  end
@@ -102,6 +102,10 @@ module Google
102
102
  # @!attribute [rw] type
103
103
  # @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::EntityType]
104
104
  # The type of the containing entity resource.
105
+ # @!attribute [rw] sampled_data_locations
106
+ # @return [::Array<::String>]
107
+ # The locations of the data items (e.g., a Cloud Storage objects) sampled
108
+ # for metadata inference.
105
109
  class PartitionDetails
106
110
  include ::Google::Protobuf::MessageExts
107
111
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -61,7 +61,8 @@ module Google
61
61
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
62
62
  # @!attribute [rw] etag
63
63
  # @return [::String]
64
- # Required. The etag associated with the partition if it was previously retrieved.
64
+ # Required. The etag associated with the entity, which can be retrieved with a
65
+ # [GetEntity][] request.
65
66
  class DeleteEntityRequest
66
67
  include ::Google::Protobuf::MessageExts
67
68
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -94,15 +95,16 @@ module Google
94
95
  # - Entity ID: ?filter="id=entityID"
95
96
  # - Asset ID: ?filter="asset=assetID"
96
97
  # - Data path ?filter="data_path=gs://my-bucket"
97
- # - Is HIVE compatible: ?filter=”hive_compatible=true
98
- # - Is BigQuery compatible: ?filter=”bigquery_compatible=true
98
+ # - Is HIVE compatible: ?filter="hive_compatible=true"
99
+ # - Is BigQuery compatible: ?filter="bigquery_compatible=true"
99
100
  class ListEntitiesRequest
100
101
  include ::Google::Protobuf::MessageExts
101
102
  extend ::Google::Protobuf::MessageExts::ClassMethods
102
103
 
103
104
  # Entity views.
104
105
  module EntityView
105
- # The default unset value. The API will default to the FULL view.
106
+ # The default unset value. Return both table and fileset entities
107
+ # if unspecified.
106
108
  ENTITY_VIEW_UNSPECIFIED = 0
107
109
 
108
110
  # Only list table entities.
@@ -173,14 +175,14 @@ module Google
173
175
  # page token.
174
176
  # @!attribute [rw] filter
175
177
  # @return [::String]
176
- # Optional. Filter the partitions returned to the caller using a key vslue pair
177
- # expression. The filter expression supports:
178
+ # Optional. Filter the partitions returned to the caller using a key value pair
179
+ # expression. Supported operators and syntax:
178
180
  #
179
- # - logical operators: AND, OR
181
+ # - logic operators: AND, OR
180
182
  # - comparison operators: <, >, >=, <= ,=, !=
181
183
  # - LIKE operators:
182
- # - The right hand of a LIKE operator supports “.” and
183
- # “*” for wildcard searches, for example "value1 LIKE ".*oo.*"
184
+ # - The right hand of a LIKE operator supports "." and
185
+ # "*" for wildcard searches, for example "value1 LIKE ".*oo.*"
184
186
  # - parenthetical grouping: ( )
185
187
  #
186
188
  # Sample filter expression: `?filter="key1 < value1 OR key2 > value2"
@@ -224,7 +226,7 @@ module Google
224
226
  # partition values separated by "/". All values must be provided.
225
227
  # @!attribute [rw] etag
226
228
  # @return [::String]
227
- # Optional. The etag associated with the partition if it was previously retrieved.
229
+ # Optional. The etag associated with the partition.
228
230
  class DeletePartitionRequest
229
231
  include ::Google::Protobuf::MessageExts
230
232
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -262,7 +264,7 @@ module Google
262
264
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`.
263
265
  # @!attribute [rw] display_name
264
266
  # @return [::String]
265
- # Optional. Display name must be shorter than or equal to 63 characters.
267
+ # Optional. Display name must be shorter than or equal to 256 characters.
266
268
  # @!attribute [rw] description
267
269
  # @return [::String]
268
270
  # Optional. User friendly longer description text. Must be shorter than or equal to
@@ -279,11 +281,12 @@ module Google
279
281
  # published table name. Specifying a new ID in an update entity
280
282
  # request will override the existing value.
281
283
  # The ID must contain only letters (a-z, A-Z), numbers (0-9), and
282
- # underscores. Must begin with a letter.
284
+ # underscores. Must begin with a letter and consist of 256 or fewer
285
+ # characters.
283
286
  # @!attribute [rw] etag
284
287
  # @return [::String]
285
- # Optional. The etag for this entity. Required for update and delete requests. Must
286
- # match the server's etag.
288
+ # Optional. The etag associated with the entity, which can be retrieved with a
289
+ # [GetEntity][] request. Required for update and delete requests.
287
290
  # @!attribute [rw] type
288
291
  # @return [::Google::Cloud::Dataplex::V1::Entity::Type]
289
292
  # Required. Immutable. The type of entity.
@@ -367,13 +370,11 @@ module Google
367
370
  # Represents partition metadata contained within entity instances.
368
371
  # @!attribute [r] name
369
372
  # @return [::String]
370
- # Output only. The values must be HTML URL encoded two times before constructing the path.
371
- # For example, if you have a value of "US:CA", encoded it two times and you
372
- # get "US%253ACA". Then if you have the 2nd value is "CA#Sunnyvale", encoded
373
- # two times and you get "CA%2523Sunnyvale". The partition values path is
374
- # "US%253ACA/CA%2523Sunnyvale". The final URL will be
375
- # "https://.../partitions/US%253ACA/CA%2523Sunnyvale". The name field in the
376
- # responses will always have the encoded format.
373
+ # Output only. Partition values used in the HTTP URL must be
374
+ # double encoded. For example, `url_encode(url_encode(value))` can be used
375
+ # to encode "US:CA/CA#Sunnyvale so that the request URL ends
376
+ # with "/partitions/US%253ACA/CA%2523Sunnyvale".
377
+ # The name field in the response retains the encoded format.
377
378
  # @!attribute [rw] values
378
379
  # @return [::Array<::String>]
379
380
  # Required. Immutable. The set of values representing the partition, which correspond to the
@@ -394,26 +395,23 @@ module Google
394
395
  # Schema information describing the structure and layout of the data.
395
396
  # @!attribute [rw] user_managed
396
397
  # @return [::Boolean]
397
- # Required. Whether the schema is user-managed or managed by the service.
398
- # - Set user_manage to false if you would like Dataplex to help you manage
399
- # the schema. You will get the full service provided by Dataplex discovery,
400
- # including new data discovery, schema inference and schema evolution. You
401
- # can still provide input the schema of the entities, for example renaming a
402
- # schema field, changing CSV or Json options if you think the discovered
403
- # values are not as accurate. Dataplex will consider your input as the
404
- # initial schema (as if they were produced by the previous discovery run),
405
- # and will evolve schema or flag actions based on that.
406
- # - Set user_manage to true if you would like to fully manage the entity
407
- # schema by yourself. This is useful when you would like to manually specify
408
- # the schema for a table. In this case, the schema defined by the user is
409
- # guaranteed to be kept unchanged and would not be overwritten. But this also
410
- # means Dataplex will not provide schema evolution management for you.
411
- # Dataplex will still be able to manage partition registration (i.e., keeping
412
- # the list of partitions up to date) when Dataplex discovery is turned on and
413
- # user_managed is set to true.
398
+ # Required. Set to `true` if user-managed or `false` if managed by Dataplex. The
399
+ # default is `false` (managed by Dataplex).
400
+ #
401
+ # - Set to `false`to enable Dataplex discovery to update the schema.
402
+ # including new data discovery, schema inference, and schema evolution.
403
+ # Users retain the ability to input and edit the schema. Dataplex
404
+ # treats schema input by the user as though produced
405
+ # by a previous Dataplex discovery operation, and it will
406
+ # evolve the schema and take action based on that treatment.
407
+ #
408
+ # - Set to `true` to fully manage the entity
409
+ # schema. This setting guarantees that Dataplex will not
410
+ # change schema fields.
414
411
  # @!attribute [rw] fields
415
412
  # @return [::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>]
416
413
  # Optional. The sequence of fields describing data in table entities.
414
+ # **Note:** BigQuery SchemaFields are immutable.
417
415
  # @!attribute [rw] partition_fields
418
416
  # @return [::Array<::Google::Cloud::Dataplex::V1::Schema::PartitionField>]
419
417
  # Optional. The sequence of fields describing the partition structure in entities.
@@ -428,8 +426,9 @@ module Google
428
426
  # Represents a column field within a table schema.
429
427
  # @!attribute [rw] name
430
428
  # @return [::String]
431
- # Required. The name of the field. The maximum length is 767 characters. The name
432
- # must begins with a letter and not contains `:` and `.`.
429
+ # Required. The name of the field. Must contain only letters, numbers and
430
+ # underscores, with a maximum length of 767 characters,
431
+ # and must begin with a letter or underscore.
433
432
  # @!attribute [rw] description
434
433
  # @return [::String]
435
434
  # Optional. User friendly field description. Must be less than or equal to 1024
@@ -450,11 +449,13 @@ module Google
450
449
 
451
450
  # Represents a key field within the entity's partition structure. You could
452
451
  # have up to 20 partition fields, but only the first 10 partitions have the
453
- # filtering ability due to performance consideration.
452
+ # filtering ability due to performance consideration. **Note:**
453
+ # Partition fields are immutable.
454
454
  # @!attribute [rw] name
455
455
  # @return [::String]
456
- # Required. Partition name is editable if only the partition style is not HIVE
457
- # compatible. The maximum length allowed is 767 characters.
456
+ # Required. Partition field name must consist of letters, numbers, and underscores
457
+ # only, with a maximum of length of 256 characters,
458
+ # and must begin with a letter or underscore..
458
459
  # @!attribute [rw] type
459
460
  # @return [::Google::Cloud::Dataplex::V1::Schema::Type]
460
461
  # Required. Immutable. The type of field.
@@ -555,6 +556,7 @@ module Google
555
556
  # @return [::String]
556
557
  # Required. The mime type descriptor for the data. Must match the pattern
557
558
  # \\{type}/\\{subtype}. Supported values:
559
+ #
558
560
  # - application/x-parquet
559
561
  # - application/x-avro
560
562
  # - application/x-orc
@@ -590,8 +592,9 @@ module Google
590
592
  # Optional. The delimiter used to separate values. Defaults to ','.
591
593
  # @!attribute [rw] quote
592
594
  # @return [::String]
593
- # Optional. The character used to quote column values. Accepts '"' and '''.
594
- # Defaults to '"' if unspecified.
595
+ # Optional. The character used to quote column values. Accepts '"'
596
+ # (double quotation mark) or ''' (single quotation mark). Defaults to
597
+ # '"' (double quotation mark) if unspecified.
595
598
  class CsvOptions
596
599
  include ::Google::Protobuf::MessageExts
597
600
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -154,7 +154,7 @@ module Google
154
154
  # @!attribute [r] name
155
155
  # @return [::String]
156
156
  # Output only. The relative resource name of the zone, of the form:
157
- # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`
157
+ # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
158
158
  # @!attribute [rw] display_name
159
159
  # @return [::String]
160
160
  # Optional. User friendly display name.
@@ -70,7 +70,7 @@ module Google
70
70
  # @!attribute [rw] name
71
71
  # @return [::String]
72
72
  # Required. The resource name of the lake:
73
- # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`
73
+ # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
74
74
  class DeleteLakeRequest
75
75
  include ::Google::Protobuf::MessageExts
76
76
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -123,7 +123,7 @@ module Google
123
123
  # @!attribute [rw] parent
124
124
  # @return [::String]
125
125
  # Required. The resource name of the parent lake:
126
- # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`
126
+ # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
127
127
  # @!attribute [rw] page_size
128
128
  # @return [::Integer]
129
129
  # Optional. Maximum number of actions to return. The service may return fewer than this
@@ -292,7 +292,7 @@ module Google
292
292
  # @!attribute [rw] parent
293
293
  # @return [::String]
294
294
  # Required. The resource name of the parent zone:
295
- # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`
295
+ # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
296
296
  # @!attribute [rw] asset_id
297
297
  # @return [::String]
298
298
  # Required. Asset identifier.
@@ -536,7 +536,7 @@ module Google
536
536
  # @!attribute [rw] name
537
537
  # @return [::String]
538
538
  # Required. The resource name of the task:
539
- # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}`
539
+ # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}`.
540
540
  class GetTaskRequest
541
541
  include ::Google::Protobuf::MessageExts
542
542
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -600,7 +600,7 @@ module Google
600
600
  # @!attribute [rw] parent
601
601
  # @return [::String]
602
602
  # Required. The resource name of the parent lake:
603
- # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}
603
+ # `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`.
604
604
  # @!attribute [rw] environment_id
605
605
  # @return [::String]
606
606
  # Required. Environment identifier.
@@ -642,7 +642,7 @@ module Google
642
642
  # @!attribute [rw] name
643
643
  # @return [::String]
644
644
  # Required. The resource name of the environment:
645
- # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}/environments/\\{environment_id}`
645
+ # `projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}`.
646
646
  class DeleteEnvironmentRequest
647
647
  include ::Google::Protobuf::MessageExts
648
648
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -652,7 +652,7 @@ module Google
652
652
  # @!attribute [rw] parent
653
653
  # @return [::String]
654
654
  # Required. The resource name of the parent lake:
655
- # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}
655
+ # `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`.
656
656
  # @!attribute [rw] page_size
657
657
  # @return [::Integer]
658
658
  # Optional. Maximum number of environments to return. The service may return fewer than
@@ -692,7 +692,7 @@ module Google
692
692
  # @!attribute [rw] name
693
693
  # @return [::String]
694
694
  # Required. The resource name of the environment:
695
- # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}/environments/\\{environment_id}
695
+ # `projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}`.
696
696
  class GetEnvironmentRequest
697
697
  include ::Google::Protobuf::MessageExts
698
698
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -702,7 +702,7 @@ module Google
702
702
  # @!attribute [rw] parent
703
703
  # @return [::String]
704
704
  # Required. The resource name of the parent environment:
705
- # projects/\\{project_number}/locations/\\{location_id}/lakes/\\{lake_id}/environment/\\{environment_id}
705
+ # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}`.
706
706
  # @!attribute [rw] page_size
707
707
  # @return [::Integer]
708
708
  # Optional. Maximum number of sessions to return. The service may return fewer than
@@ -714,6 +714,17 @@ module Google
714
714
  # retrieve the subsequent page. When paginating, all other parameters
715
715
  # provided to `ListSessions` must match the call that provided the page
716
716
  # token.
717
+ # @!attribute [rw] filter
718
+ # @return [::String]
719
+ # Optional. Filter request. The following `mode` filter is supported to return only the
720
+ # sessions belonging to the requester when the mode is USER and return
721
+ # sessions of all the users when the mode is ADMIN. When no filter is sent
722
+ # default to USER mode.
723
+ # NOTE: When the mode is ADMIN, the requester should have
724
+ # `dataplex.environments.listAllSessions` permission to list all sessions,
725
+ # in absence of the permission, the request fails.
726
+ #
727
+ # mode = ADMIN | USER
717
728
  class ListSessionsRequest
718
729
  include ::Google::Protobuf::MessageExts
719
730
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -55,6 +55,9 @@ module Google
55
55
  # @!attribute [rw] execution_spec
56
56
  # @return [::Google::Cloud::Dataplex::V1::Task::ExecutionSpec]
57
57
  # Required. Spec related to how a task is executed.
58
+ # @!attribute [r] execution_status
59
+ # @return [::Google::Cloud::Dataplex::V1::Task::ExecutionStatus]
60
+ # Output only. Status of the latest task executions.
58
61
  # @!attribute [rw] spark
59
62
  # @return [::Google::Cloud::Dataplex::V1::Task::SparkTaskConfig]
60
63
  # Config related to running custom Spark tasks.
@@ -80,26 +83,31 @@ module Google
80
83
  # @!attribute [rw] executors_count
81
84
  # @return [::Integer]
82
85
  # Optional. Total number of job executors.
86
+ # Executor Count should be between 2 and 100. [Default=2]
83
87
  # @!attribute [rw] max_executors_count
84
88
  # @return [::Integer]
85
89
  # Optional. Max configurable executors.
86
90
  # If max_executors_count > executors_count, then auto-scaling is enabled.
91
+ # Max Executor Count should be between 2 and 1000. [Default=1000]
87
92
  class BatchComputeResources
88
93
  include ::Google::Protobuf::MessageExts
89
94
  extend ::Google::Protobuf::MessageExts::ClassMethods
90
95
  end
91
96
 
92
97
  # Container Image Runtime Configuration used with Batch execution.
98
+ # @!attribute [rw] image
99
+ # @return [::String]
100
+ # Optional. Container image to use.
93
101
  # @!attribute [rw] java_jars
94
102
  # @return [::Array<::String>]
95
103
  # Optional. A list of Java JARS to add to the classpath.
96
104
  # Valid input includes Cloud Storage URIs to Jar binaries.
97
- # For example, `gs://bucket-name/my/path/to/file.jar`.
105
+ # For example, gs://bucket-name/my/path/to/file.jar
98
106
  # @!attribute [rw] python_packages
99
107
  # @return [::Array<::String>]
100
108
  # Optional. A list of python packages to be installed.
101
109
  # Valid formats include Cloud Storage URI to a PIP installable library.
102
- # For example, `gs://bucket-name/my/path/to/lib.tar.gz`.
110
+ # For example, gs://bucket-name/my/path/to/lib.tar.gz
103
111
  # @!attribute [rw] properties
104
112
  # @return [::Google::Protobuf::Map{::String => ::String}]
105
113
  # Optional. Override to common configuration of open source components installed on
@@ -205,9 +213,18 @@ module Google
205
213
  # Required. Service account to use to execute a task.
206
214
  # If not provided, the default Compute service account for the project is
207
215
  # used.
216
+ # @!attribute [rw] project
217
+ # @return [::String]
218
+ # Optional. The project in which jobs are run. By default, the project containing the
219
+ # Lake is used. If a project is provided, the
220
+ # {::Google::Cloud::Dataplex::V1::Task::ExecutionSpec#service_account ExecutionSpec.service_account} must belong to this project.
208
221
  # @!attribute [rw] max_job_execution_lifetime
209
222
  # @return [::Google::Protobuf::Duration]
210
223
  # Optional. The maximum duration after which the job execution is expired.
224
+ # @!attribute [rw] kms_key
225
+ # @return [::String]
226
+ # Optional. The Cloud KMS key to use for encryption, of the form:
227
+ # `projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}`.
211
228
  class ExecutionSpec
212
229
  include ::Google::Protobuf::MessageExts
213
230
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -268,6 +285,18 @@ module Google
268
285
  extend ::Google::Protobuf::MessageExts::ClassMethods
269
286
  end
270
287
 
288
+ # Status of the task execution (e.g. Jobs).
289
+ # @!attribute [r] update_time
290
+ # @return [::Google::Protobuf::Timestamp]
291
+ # Output only. Last update time of the status.
292
+ # @!attribute [r] latest_job
293
+ # @return [::Google::Cloud::Dataplex::V1::Job]
294
+ # Output only. latest job execution
295
+ class ExecutionStatus
296
+ include ::Google::Protobuf::MessageExts
297
+ extend ::Google::Protobuf::MessageExts::ClassMethods
298
+ end
299
+
271
300
  # @!attribute [rw] key
272
301
  # @return [::String]
273
302
  # @!attribute [rw] value