google-cloud-dataplex-v1 0.5.0 → 0.5.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -38,8 +38,8 @@ module Google
38
38
  # Optional. User friendly display name.
39
39
  # @!attribute [r] uid
40
40
  # @return [::String]
41
- # Output only. System generated globally unique ID for the lake. This ID will be
42
- # different if the lake is deleted and re-created with the same name.
41
+ # Output only. System generated globally unique ID for the lake. This ID will
42
+ # be different if the lake is deleted and re-created with the same name.
43
43
  # @!attribute [r] create_time
44
44
  # @return [::Google::Protobuf::Timestamp]
45
45
  # Output only. The time when the lake was created.
@@ -57,8 +57,9 @@ module Google
57
57
  # Output only. Current state of the lake.
58
58
  # @!attribute [r] service_account
59
59
  # @return [::String]
60
- # Output only. Service account associated with this lake. This service account must be
61
- # authorized to access or operate on resources managed by the lake.
60
+ # Output only. Service account associated with this lake. This service
61
+ # account must be authorized to access or operate on resources managed by the
62
+ # lake.
62
63
  # @!attribute [rw] metastore
63
64
  # @return [::Google::Cloud::Dataplex::V1::Lake::Metastore]
64
65
  # Optional. Settings to manage lake and Dataproc Metastore service instance
@@ -160,8 +161,8 @@ module Google
160
161
  # Optional. User friendly display name.
161
162
  # @!attribute [r] uid
162
163
  # @return [::String]
163
- # Output only. System generated globally unique ID for the zone. This ID will be
164
- # different if the zone is deleted and re-created with the same name.
164
+ # Output only. System generated globally unique ID for the zone. This ID will
165
+ # be different if the zone is deleted and re-created with the same name.
165
166
  # @!attribute [r] create_time
166
167
  # @return [::Google::Protobuf::Timestamp]
167
168
  # Output only. The time when the zone was created.
@@ -182,11 +183,12 @@ module Google
182
183
  # Required. Immutable. The type of the zone.
183
184
  # @!attribute [rw] discovery_spec
184
185
  # @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec]
185
- # Optional. Specification of the discovery feature applied to data in this zone.
186
+ # Optional. Specification of the discovery feature applied to data in this
187
+ # zone.
186
188
  # @!attribute [rw] resource_spec
187
189
  # @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec]
188
- # Required. Specification of the resources that are referenced by the assets within
189
- # this zone.
190
+ # Required. Specification of the resources that are referenced by the assets
191
+ # within this zone.
190
192
  # @!attribute [r] asset_status
191
193
  # @return [::Google::Cloud::Dataplex::V1::AssetStatus]
192
194
  # Output only. Aggregated status of the underlying assets of the zone.
@@ -197,8 +199,8 @@ module Google
197
199
  # Settings for resources attached as assets within a zone.
198
200
  # @!attribute [rw] location_type
199
201
  # @return [::Google::Cloud::Dataplex::V1::Zone::ResourceSpec::LocationType]
200
- # Required. Immutable. The location type of the resources that are allowed to be attached to the
201
- # assets within this zone.
202
+ # Required. Immutable. The location type of the resources that are allowed
203
+ # to be attached to the assets within this zone.
202
204
  class ResourceSpec
203
205
  include ::Google::Protobuf::MessageExts
204
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -222,16 +224,16 @@ module Google
222
224
  # Required. Whether discovery is enabled.
223
225
  # @!attribute [rw] include_patterns
224
226
  # @return [::Array<::String>]
225
- # Optional. The list of patterns to apply for selecting data to include during
226
- # discovery if only a subset of the data should considered. For Cloud
227
- # Storage bucket assets, these are interpreted as glob patterns used to
228
- # match object names. For BigQuery dataset assets, these are
229
- # interpreted as patterns to match table names.
227
+ # Optional. The list of patterns to apply for selecting data to include
228
+ # during discovery if only a subset of the data should considered. For
229
+ # Cloud Storage bucket assets, these are interpreted as glob patterns used
230
+ # to match object names. For BigQuery dataset assets, these are interpreted
231
+ # as patterns to match table names.
230
232
  # @!attribute [rw] exclude_patterns
231
233
  # @return [::Array<::String>]
232
- # Optional. The list of patterns to apply for selecting data to exclude during
233
- # discovery. For Cloud Storage bucket assets, these are interpreted as
234
- # glob patterns used to match object names. For BigQuery dataset assets,
234
+ # Optional. The list of patterns to apply for selecting data to exclude
235
+ # during discovery. For Cloud Storage bucket assets, these are interpreted
236
+ # as glob patterns used to match object names. For BigQuery dataset assets,
235
237
  # these are interpreted as patterns to match table names.
236
238
  # @!attribute [rw] csv_options
237
239
  # @return [::Google::Cloud::Dataplex::V1::Zone::DiscoverySpec::CsvOptions]
@@ -241,15 +243,15 @@ module Google
241
243
  # Optional. Configuration for Json data.
242
244
  # @!attribute [rw] schedule
243
245
  # @return [::String]
244
- # Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running
245
- # discovery periodically. Successive discovery runs must be scheduled at
246
- # least 60 minutes apart.
247
- # The default value is to run discovery every 60 minutes.
248
- # To explicitly set a timezone to the cron tab, apply a prefix in the
249
- # cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or TZ=$\\{IANA_TIME_ZONE}".
250
- # The $\\{IANA_TIME_ZONE} may only be a valid string from IANA time zone
251
- # database. For example, "CRON_TZ=America/New_York 1 * * * *", or
252
- # "TZ=America/New_York 1 * * * *".
246
+ # Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
247
+ # running discovery periodically. Successive discovery runs must be
248
+ # scheduled at least 60 minutes apart. The default value is to run
249
+ # discovery every 60 minutes. To explicitly set a timezone to the cron
250
+ # tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
251
+ # TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
252
+ # from IANA time zone database. For example,
253
+ # `CRON_TZ=America/New_York 1 * * * *`,
254
+ # or `TZ=America/New_York 1 * * * *`.
253
255
  class DiscoverySpec
254
256
  include ::Google::Protobuf::MessageExts
255
257
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -257,11 +259,12 @@ module Google
257
259
  # Describe CSV and similar semi-structured data formats.
258
260
  # @!attribute [rw] header_rows
259
261
  # @return [::Integer]
260
- # Optional. The number of rows to interpret as header rows that should be skipped
261
- # when reading data rows.
262
+ # Optional. The number of rows to interpret as header rows that should be
263
+ # skipped when reading data rows.
262
264
  # @!attribute [rw] delimiter
263
265
  # @return [::String]
264
- # Optional. The delimiter being used to separate values. This defaults to ','.
266
+ # Optional. The delimiter being used to separate values. This defaults to
267
+ # ','.
265
268
  # @!attribute [rw] encoding
266
269
  # @return [::String]
267
270
  # Optional. The character encoding of the data. The default is UTF-8.
@@ -520,8 +523,9 @@ module Google
520
523
  # Optional. User friendly display name.
521
524
  # @!attribute [r] uid
522
525
  # @return [::String]
523
- # Output only. System generated globally unique ID for the asset. This ID will be
524
- # different if the asset is deleted and re-created with the same name.
526
+ # Output only. System generated globally unique ID for the asset. This ID
527
+ # will be different if the asset is deleted and re-created with the same
528
+ # name.
525
529
  # @!attribute [r] create_time
526
530
  # @return [::Google::Protobuf::Timestamp]
527
531
  # Output only. The time when the asset was created.
@@ -545,16 +549,17 @@ module Google
545
549
  # Output only. Status of the resource referenced by this asset.
546
550
  # @!attribute [r] security_status
547
551
  # @return [::Google::Cloud::Dataplex::V1::Asset::SecurityStatus]
548
- # Output only. Status of the security policy applied to resource referenced by this asset.
552
+ # Output only. Status of the security policy applied to resource referenced
553
+ # by this asset.
549
554
  # @!attribute [rw] discovery_spec
550
555
  # @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec]
551
- # Optional. Specification of the discovery feature applied to data referenced by this
552
- # asset.
553
- # When this spec is left unset, the asset will use the spec set on the parent
554
- # zone.
556
+ # Optional. Specification of the discovery feature applied to data referenced
557
+ # by this asset. When this spec is left unset, the asset will use the spec
558
+ # set on the parent zone.
555
559
  # @!attribute [r] discovery_status
556
560
  # @return [::Google::Cloud::Dataplex::V1::Asset::DiscoveryStatus]
557
- # Output only. Status of the discovery feature applied to data referenced by this asset.
561
+ # Output only. Status of the discovery feature applied to data referenced by
562
+ # this asset.
558
563
  class Asset
559
564
  include ::Google::Protobuf::MessageExts
560
565
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -599,16 +604,16 @@ module Google
599
604
  # Optional. Whether discovery is enabled.
600
605
  # @!attribute [rw] include_patterns
601
606
  # @return [::Array<::String>]
602
- # Optional. The list of patterns to apply for selecting data to include during
603
- # discovery if only a subset of the data should considered. For Cloud
604
- # Storage bucket assets, these are interpreted as glob patterns used to
605
- # match object names. For BigQuery dataset assets, these are interpreted as
606
- # patterns to match table names.
607
+ # Optional. The list of patterns to apply for selecting data to include
608
+ # during discovery if only a subset of the data should considered. For
609
+ # Cloud Storage bucket assets, these are interpreted as glob patterns used
610
+ # to match object names. For BigQuery dataset assets, these are interpreted
611
+ # as patterns to match table names.
607
612
  # @!attribute [rw] exclude_patterns
608
613
  # @return [::Array<::String>]
609
- # Optional. The list of patterns to apply for selecting data to exclude during
610
- # discovery. For Cloud Storage bucket assets, these are interpreted as
611
- # glob patterns used to match object names. For BigQuery dataset assets,
614
+ # Optional. The list of patterns to apply for selecting data to exclude
615
+ # during discovery. For Cloud Storage bucket assets, these are interpreted
616
+ # as glob patterns used to match object names. For BigQuery dataset assets,
612
617
  # these are interpreted as patterns to match table names.
613
618
  # @!attribute [rw] csv_options
614
619
  # @return [::Google::Cloud::Dataplex::V1::Asset::DiscoverySpec::CsvOptions]
@@ -618,15 +623,15 @@ module Google
618
623
  # Optional. Configuration for Json data.
619
624
  # @!attribute [rw] schedule
620
625
  # @return [::String]
621
- # Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running
622
- # discovery periodically. Successive discovery runs must be scheduled at
623
- # least 60 minutes apart.
624
- # The default value is to run discovery every 60 minutes.
625
- # To explicitly set a timezone to the cron tab, apply a prefix in the
626
- # cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or TZ=$\\{IANA_TIME_ZONE}".
627
- # The $\\{IANA_TIME_ZONE} may only be a valid string from IANA time zone
628
- # database. For example, "CRON_TZ=America/New_York 1 * * * *", or
629
- # "TZ=America/New_York 1 * * * *".
626
+ # Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
627
+ # running discovery periodically. Successive discovery runs must be
628
+ # scheduled at least 60 minutes apart. The default value is to run
629
+ # discovery every 60 minutes. To explicitly set a timezone to the cron
630
+ # tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
631
+ # TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
632
+ # from IANA time zone database. For example,
633
+ # `CRON_TZ=America/New_York 1 * * * *`,
634
+ # or `TZ=America/New_York 1 * * * *`.
630
635
  class DiscoverySpec
631
636
  include ::Google::Protobuf::MessageExts
632
637
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -634,11 +639,12 @@ module Google
634
639
  # Describe CSV and similar semi-structured data formats.
635
640
  # @!attribute [rw] header_rows
636
641
  # @return [::Integer]
637
- # Optional. The number of rows to interpret as header rows that should be skipped
638
- # when reading data rows.
642
+ # Optional. The number of rows to interpret as header rows that should be
643
+ # skipped when reading data rows.
639
644
  # @!attribute [rw] delimiter
640
645
  # @return [::String]
641
- # Optional. The delimiter being used to separate values. This defaults to ','.
646
+ # Optional. The delimiter being used to separate values. This defaults to
647
+ # ','.
642
648
  # @!attribute [rw] encoding
643
649
  # @return [::String]
644
650
  # Optional. The character encoding of the data. The default is UTF-8.
@@ -669,8 +675,8 @@ module Google
669
675
  # Identifies the cloud resource that is referenced by this asset.
670
676
  # @!attribute [rw] name
671
677
  # @return [::String]
672
- # Immutable. Relative name of the cloud resource that contains the data that is
673
- # being managed within a lake. For example:
678
+ # Immutable. Relative name of the cloud resource that contains the data
679
+ # that is being managed within a lake. For example:
674
680
  # `projects/{project_number}/buckets/{bucket_id}`
675
681
  # `projects/{project_number}/datasets/{dataset_id}`
676
682
  # @!attribute [rw] type
@@ -84,13 +84,13 @@ module Google
84
84
  # where `location_id` refers to a GCP region.
85
85
  # @!attribute [rw] page_size
86
86
  # @return [::Integer]
87
- # Optional. Maximum number of Lakes to return. The service may return fewer than this
88
- # value. If unspecified, at most 10 lakes will be returned. The maximum
89
- # value is 1000; values above 1000 will be coerced to 1000.
87
+ # Optional. Maximum number of Lakes to return. The service may return fewer
88
+ # than this value. If unspecified, at most 10 lakes will be returned. The
89
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
90
90
  # @!attribute [rw] page_token
91
91
  # @return [::String]
92
- # Optional. Page token received from a previous `ListLakes` call. Provide this to
93
- # retrieve the subsequent page. When paginating, all other parameters
92
+ # Optional. Page token received from a previous `ListLakes` call. Provide
93
+ # this to retrieve the subsequent page. When paginating, all other parameters
94
94
  # provided to `ListLakes` must match the call that provided the page token.
95
95
  # @!attribute [rw] filter
96
96
  # @return [::String]
@@ -126,15 +126,15 @@ module Google
126
126
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
127
127
  # @!attribute [rw] page_size
128
128
  # @return [::Integer]
129
- # Optional. Maximum number of actions to return. The service may return fewer than this
130
- # value. If unspecified, at most 10 actions will be returned. The maximum
131
- # value is 1000; values above 1000 will be coerced to 1000.
129
+ # Optional. Maximum number of actions to return. The service may return fewer
130
+ # than this value. If unspecified, at most 10 actions will be returned. The
131
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
132
132
  # @!attribute [rw] page_token
133
133
  # @return [::String]
134
- # Optional. Page token received from a previous `ListLakeActions` call. Provide this to
135
- # retrieve the subsequent page. When paginating, all other parameters
136
- # provided to `ListLakeActions` must match the call that provided the page
137
- # token.
134
+ # Optional. Page token received from a previous `ListLakeActions` call.
135
+ # Provide this to retrieve the subsequent page. When paginating, all other
136
+ # parameters provided to `ListLakeActions` must match the call that provided
137
+ # the page token.
138
138
  class ListLakeActionsRequest
139
139
  include ::Google::Protobuf::MessageExts
140
140
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -225,13 +225,13 @@ module Google
225
225
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
226
226
  # @!attribute [rw] page_size
227
227
  # @return [::Integer]
228
- # Optional. Maximum number of zones to return. The service may return fewer than this
229
- # value. If unspecified, at most 10 zones will be returned. The maximum
230
- # value is 1000; values above 1000 will be coerced to 1000.
228
+ # Optional. Maximum number of zones to return. The service may return fewer
229
+ # than this value. If unspecified, at most 10 zones will be returned. The
230
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
231
231
  # @!attribute [rw] page_token
232
232
  # @return [::String]
233
- # Optional. Page token received from a previous `ListZones` call. Provide this to
234
- # retrieve the subsequent page. When paginating, all other parameters
233
+ # Optional. Page token received from a previous `ListZones` call. Provide
234
+ # this to retrieve the subsequent page. When paginating, all other parameters
235
235
  # provided to `ListZones` must match the call that provided the page token.
236
236
  # @!attribute [rw] filter
237
237
  # @return [::String]
@@ -264,15 +264,15 @@ module Google
264
264
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
265
265
  # @!attribute [rw] page_size
266
266
  # @return [::Integer]
267
- # Optional. Maximum number of actions to return. The service may return fewer than this
268
- # value. If unspecified, at most 10 actions will be returned. The maximum
269
- # value is 1000; values above 1000 will be coerced to 1000.
267
+ # Optional. Maximum number of actions to return. The service may return fewer
268
+ # than this value. If unspecified, at most 10 actions will be returned. The
269
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
270
270
  # @!attribute [rw] page_token
271
271
  # @return [::String]
272
- # Optional. Page token received from a previous `ListZoneActions` call. Provide this to
273
- # retrieve the subsequent page. When paginating, all other parameters
274
- # provided to `ListZoneActions` must match the call that provided the page
275
- # token.
272
+ # Optional. Page token received from a previous `ListZoneActions` call.
273
+ # Provide this to retrieve the subsequent page. When paginating, all other
274
+ # parameters provided to `ListZoneActions` must match the call that provided
275
+ # the page token.
276
276
  class ListZoneActionsRequest
277
277
  include ::Google::Protobuf::MessageExts
278
278
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -349,13 +349,13 @@ module Google
349
349
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
350
350
  # @!attribute [rw] page_size
351
351
  # @return [::Integer]
352
- # Optional. Maximum number of asset to return. The service may return fewer than
353
- # this value. If unspecified, at most 10 assets will be returned. The
352
+ # Optional. Maximum number of asset to return. The service may return fewer
353
+ # than this value. If unspecified, at most 10 assets will be returned. The
354
354
  # maximum value is 1000; values above 1000 will be coerced to 1000.
355
355
  # @!attribute [rw] page_token
356
356
  # @return [::String]
357
- # Optional. Page token received from a previous `ListAssets` call. Provide this to
358
- # retrieve the subsequent page. When paginating, all other parameters
357
+ # Optional. Page token received from a previous `ListAssets` call. Provide
358
+ # this to retrieve the subsequent page. When paginating, all other parameters
359
359
  # provided to `ListAssets` must match the call that provided the page
360
360
  # token.
361
361
  # @!attribute [rw] filter
@@ -389,15 +389,15 @@ module Google
389
389
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.
390
390
  # @!attribute [rw] page_size
391
391
  # @return [::Integer]
392
- # Optional. Maximum number of actions to return. The service may return fewer than this
393
- # value. If unspecified, at most 10 actions will be returned. The maximum
394
- # value is 1000; values above 1000 will be coerced to 1000.
392
+ # Optional. Maximum number of actions to return. The service may return fewer
393
+ # than this value. If unspecified, at most 10 actions will be returned. The
394
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
395
395
  # @!attribute [rw] page_token
396
396
  # @return [::String]
397
- # Optional. Page token received from a previous `ListAssetActions` call. Provide this
398
- # to retrieve the subsequent page. When paginating, all other parameters
399
- # provided to `ListAssetActions` must match the call that provided the page
400
- # token.
397
+ # Optional. Page token received from a previous `ListAssetActions` call.
398
+ # Provide this to retrieve the subsequent page. When paginating, all other
399
+ # parameters provided to `ListAssetActions` must match the call that provided
400
+ # the page token.
401
401
  class ListAssetActionsRequest
402
402
  include ::Google::Protobuf::MessageExts
403
403
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -433,8 +433,9 @@ module Google
433
433
  # @return [::Boolean]
434
434
  # Output only. Identifies whether the user has requested cancellation
435
435
  # of the operation. Operations that have successfully been cancelled
436
- # have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
437
- # corresponding to `Code.CANCELLED`.
436
+ # have [Operation.error][] value with a
437
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
438
+ # `Code.CANCELLED`.
438
439
  # @!attribute [r] api_version
439
440
  # @return [::String]
440
441
  # Output only. API version used to start the operation.
@@ -497,13 +498,13 @@ module Google
497
498
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
498
499
  # @!attribute [rw] page_size
499
500
  # @return [::Integer]
500
- # Optional. Maximum number of tasks to return. The service may return fewer than this
501
- # value. If unspecified, at most 10 tasks will be returned. The maximum
502
- # value is 1000; values above 1000 will be coerced to 1000.
501
+ # Optional. Maximum number of tasks to return. The service may return fewer
502
+ # than this value. If unspecified, at most 10 tasks will be returned. The
503
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
503
504
  # @!attribute [rw] page_token
504
505
  # @return [::String]
505
- # Optional. Page token received from a previous `ListZones` call. Provide this to
506
- # retrieve the subsequent page. When paginating, all other parameters
506
+ # Optional. Page token received from a previous `ListZones` call. Provide
507
+ # this to retrieve the subsequent page. When paginating, all other parameters
507
508
  # provided to `ListZones` must match the call that provided the page token.
508
509
  # @!attribute [rw] filter
509
510
  # @return [::String]
@@ -559,13 +560,13 @@ module Google
559
560
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`.
560
561
  # @!attribute [rw] page_size
561
562
  # @return [::Integer]
562
- # Optional. Maximum number of jobs to return. The service may return fewer than
563
- # this value. If unspecified, at most 10 jobs will be returned. The
563
+ # Optional. Maximum number of jobs to return. The service may return fewer
564
+ # than this value. If unspecified, at most 10 jobs will be returned. The
564
565
  # maximum value is 1000; values above 1000 will be coerced to 1000.
565
566
  # @!attribute [rw] page_token
566
567
  # @return [::String]
567
- # Optional. Page token received from a previous `ListJobs` call. Provide this to
568
- # retrieve the subsequent page. When paginating, all other parameters
568
+ # Optional. Page token received from a previous `ListJobs` call. Provide this
569
+ # to retrieve the subsequent page. When paginating, all other parameters
569
570
  # provided to `ListJobs` must match the call that provided the page
570
571
  # token.
571
572
  class ListJobsRequest
@@ -655,15 +656,16 @@ module Google
655
656
  # `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`.
656
657
  # @!attribute [rw] page_size
657
658
  # @return [::Integer]
658
- # Optional. Maximum number of environments to return. The service may return fewer than
659
- # this value. If unspecified, at most 10 environments will be returned. The
660
- # maximum value is 1000; values above 1000 will be coerced to 1000.
659
+ # Optional. Maximum number of environments to return. The service may return
660
+ # fewer than this value. If unspecified, at most 10 environments will be
661
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
662
+ # 1000.
661
663
  # @!attribute [rw] page_token
662
664
  # @return [::String]
663
- # Optional. Page token received from a previous `ListEnvironments` call. Provide this
664
- # to retrieve the subsequent page. When paginating, all other parameters
665
- # provided to `ListEnvironments` must match the call that provided the page
666
- # token.
665
+ # Optional. Page token received from a previous `ListEnvironments` call.
666
+ # Provide this to retrieve the subsequent page. When paginating, all other
667
+ # parameters provided to `ListEnvironments` must match the call that provided
668
+ # the page token.
667
669
  # @!attribute [rw] filter
668
670
  # @return [::String]
669
671
  # Optional. Filter request.
@@ -705,24 +707,24 @@ module Google
705
707
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}`.
706
708
  # @!attribute [rw] page_size
707
709
  # @return [::Integer]
708
- # Optional. Maximum number of sessions to return. The service may return fewer than
709
- # this value. If unspecified, at most 10 sessions will be returned. The
710
- # maximum value is 1000; values above 1000 will be coerced to 1000.
710
+ # Optional. Maximum number of sessions to return. The service may return
711
+ # fewer than this value. If unspecified, at most 10 sessions will be
712
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
713
+ # 1000.
711
714
  # @!attribute [rw] page_token
712
715
  # @return [::String]
713
- # Optional. Page token received from a previous `ListSessions` call. Provide this to
714
- # retrieve the subsequent page. When paginating, all other parameters
716
+ # Optional. Page token received from a previous `ListSessions` call. Provide
717
+ # this to retrieve the subsequent page. When paginating, all other parameters
715
718
  # provided to `ListSessions` must match the call that provided the page
716
719
  # token.
717
720
  # @!attribute [rw] filter
718
721
  # @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.
722
+ # Optional. Filter request. The following `mode` filter is supported to
723
+ # return only the sessions belonging to the requester when the mode is USER
724
+ # and return sessions of all the users when the mode is ADMIN. When no filter
725
+ # is sent default to USER mode. NOTE: When the mode is ADMIN, the requester
726
+ # should have `dataplex.environments.listAllSessions` permission to list all
727
+ # sessions, in absence of the permission, the request fails.
726
728
  #
727
729
  # mode = ADMIN | USER
728
730
  class ListSessionsRequest
@@ -29,8 +29,8 @@ module Google
29
29
  # tasks/\\{task_id}.
30
30
  # @!attribute [r] uid
31
31
  # @return [::String]
32
- # Output only. System generated globally unique ID for the task. This ID will be
33
- # different if the task is deleted and re-created with the same name.
32
+ # Output only. System generated globally unique ID for the task. This ID will
33
+ # be different if the task is deleted and re-created with the same name.
34
34
  # @!attribute [r] create_time
35
35
  # @return [::Google::Protobuf::Timestamp]
36
36
  # Output only. The time when the task was created.
@@ -113,12 +113,10 @@ module Google
113
113
  # For example, gs://bucket-name/my/path/to/lib.tar.gz
114
114
  # @!attribute [rw] properties
115
115
  # @return [::Google::Protobuf::Map{::String => ::String}]
116
- # Optional. Override to common configuration of open source components installed on
117
- # the Dataproc cluster.
118
- # The properties to set on daemon config files.
119
- # Property keys are specified in `prefix:property` format, for example
120
- # `core:hadoop.tmp.dir`.
121
- # For more information, see [Cluster
116
+ # Optional. Override to common configuration of open source components
117
+ # installed on the Dataproc cluster. The properties to set on daemon
118
+ # config files. Property keys are specified in `prefix:property` format,
119
+ # for example `core:hadoop.tmp.dir`. For more information, see [Cluster
122
120
  # properties](https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
123
121
  class ContainerImageRuntime
124
122
  include ::Google::Protobuf::MessageExts
@@ -137,8 +135,8 @@ module Google
137
135
  # Cloud VPC Network used to run the infrastructure.
138
136
  # @!attribute [rw] network
139
137
  # @return [::String]
140
- # Optional. The Cloud VPC network in which the job is run. By default, the Cloud
141
- # VPC network named Default within the project is used.
138
+ # Optional. The Cloud VPC network in which the job is run. By default,
139
+ # the Cloud VPC network named Default within the project is used.
142
140
  # @!attribute [rw] sub_network
143
141
  # @return [::String]
144
142
  # Optional. The Cloud VPC sub-network in which the job is run.
@@ -171,13 +169,13 @@ module Google
171
169
  # Set to zero to never attempt to retry a failed task.
172
170
  # @!attribute [rw] schedule
173
171
  # @return [::String]
174
- # Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running
175
- # tasks periodically.
176
- # To explicitly set a timezone to the cron tab, apply a prefix in the
177
- # cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or "TZ=$\\{IANA_TIME_ZONE}".
178
- # The $\\{IANA_TIME_ZONE} may only be a valid string from IANA time zone
179
- # database. For example, "CRON_TZ=America/New_York 1 * * * *", or
180
- # "TZ=America/New_York 1 * * * *".
172
+ # Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
173
+ # running tasks periodically. To explicitly set a timezone to the cron
174
+ # tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
175
+ # "TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid
176
+ # string from IANA time zone database. For example,
177
+ # `CRON_TZ=America/New_York 1 * * * *`,
178
+ # or `TZ=America/New_York 1 * * * *`.
181
179
  # This field is required for RECURRING tasks.
182
180
  class TriggerSpec
183
181
  include ::Google::Protobuf::MessageExts
@@ -218,9 +216,10 @@ module Google
218
216
  # used.
219
217
  # @!attribute [rw] project
220
218
  # @return [::String]
221
- # Optional. The project in which jobs are run. By default, the project containing the
222
- # Lake is used. If a project is provided, the
223
- # {::Google::Cloud::Dataplex::V1::Task::ExecutionSpec#service_account ExecutionSpec.service_account} must belong to this project.
219
+ # Optional. The project in which jobs are run. By default, the project
220
+ # containing the Lake is used. If a project is provided, the
221
+ # {::Google::Cloud::Dataplex::V1::Task::ExecutionSpec#service_account ExecutionSpec.service_account}
222
+ # must belong to this project.
224
223
  # @!attribute [rw] max_job_execution_lifetime
225
224
  # @return [::Google::Protobuf::Duration]
226
225
  # Optional. The maximum duration after which the job execution is expired.
@@ -273,13 +272,13 @@ module Google
273
272
  # (`set key="value";`).
274
273
  # @!attribute [rw] file_uris
275
274
  # @return [::Array<::String>]
276
- # Optional. Cloud Storage URIs of files to be placed in the working directory of each
277
- # executor.
275
+ # Optional. Cloud Storage URIs of files to be placed in the working
276
+ # directory of each executor.
278
277
  # @!attribute [rw] archive_uris
279
278
  # @return [::Array<::String>]
280
- # Optional. Cloud Storage URIs of archives to be extracted into the working directory
281
- # of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and
282
- # .zip.
279
+ # Optional. Cloud Storage URIs of archives to be extracted into the working
280
+ # directory of each executor. Supported file types: .jar, .tar, .tar.gz,
281
+ # .tgz, and .zip.
283
282
  # @!attribute [rw] infrastructure_spec
284
283
  # @return [::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec]
285
284
  # Optional. Infrastructure specification for the execution.
@@ -291,22 +290,22 @@ module Google
291
290
  # Config for running scheduled notebooks.
292
291
  # @!attribute [rw] notebook
293
292
  # @return [::String]
294
- # Required. Path to input notebook. This can be the Cloud Storage URI of the notebook
295
- # file or the path to a Notebook Content. The execution args are accessible
296
- # as environment variables
293
+ # Required. Path to input notebook. This can be the Cloud Storage URI of
294
+ # the notebook file or the path to a Notebook Content. The execution args
295
+ # are accessible as environment variables
297
296
  # (`TASK_key=value`).
298
297
  # @!attribute [rw] infrastructure_spec
299
298
  # @return [::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec]
300
299
  # Optional. Infrastructure specification for the execution.
301
300
  # @!attribute [rw] file_uris
302
301
  # @return [::Array<::String>]
303
- # Optional. Cloud Storage URIs of files to be placed in the working directory of each
304
- # executor.
302
+ # Optional. Cloud Storage URIs of files to be placed in the working
303
+ # directory of each executor.
305
304
  # @!attribute [rw] archive_uris
306
305
  # @return [::Array<::String>]
307
- # Optional. Cloud Storage URIs of archives to be extracted into the working directory
308
- # of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and
309
- # .zip.
306
+ # Optional. Cloud Storage URIs of archives to be extracted into the working
307
+ # directory of each executor. Supported file types: .jar, .tar, .tar.gz,
308
+ # .tgz, and .zip.
310
309
  class NotebookTaskConfig
311
310
  include ::Google::Protobuf::MessageExts
312
311
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -360,7 +359,8 @@ module Google
360
359
  # Output only. The underlying service running a job.
361
360
  # @!attribute [r] service_job
362
361
  # @return [::String]
363
- # Output only. The full resource name for the job run under a particular service.
362
+ # Output only. The full resource name for the job run under a particular
363
+ # service.
364
364
  # @!attribute [r] message
365
365
  # @return [::String]
366
366
  # Output only. Additional information about the current state.
@@ -28,12 +28,14 @@ module Google
28
28
  # [API Design Guide](https://cloud.google.com/apis/design/errors).
29
29
  # @!attribute [rw] code
30
30
  # @return [::Integer]
31
- # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
31
+ # The status code, which should be an enum value of
32
+ # [google.rpc.Code][google.rpc.Code].
32
33
  # @!attribute [rw] message
33
34
  # @return [::String]
34
35
  # A developer-facing error message, which should be in English. Any
35
36
  # user-facing error message should be localized and sent in the
36
- # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
37
+ # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
38
+ # by the client.
37
39
  # @!attribute [rw] details
38
40
  # @return [::Array<::Google::Protobuf::Any>]
39
41
  # A list of messages that carry the error details. There is a common set of