google-apis-dataplex_v1 0.73.0 → 0.74.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -421,7 +421,7 @@ module Google
421
421
  class GoogleCloudDataplexV1AspectType
422
422
  include Google::Apis::Core::Hashable
423
423
 
424
- # Autorization for an AspectType.
424
+ # Authorization for an AspectType.
425
425
  # Corresponds to the JSON property `authorization`
426
426
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeAuthorization]
427
427
  attr_accessor :authorization
@@ -501,7 +501,7 @@ module Google
501
501
  end
502
502
  end
503
503
 
504
- # Autorization for an AspectType.
504
+ # Authorization for an AspectType.
505
505
  class GoogleCloudDataplexV1AspectTypeAuthorization
506
506
  include Google::Apis::Core::Hashable
507
507
 
@@ -1601,7 +1601,7 @@ module Google
1601
1601
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing]
1602
1602
  attr_accessor :bigquery_publishing
1603
1603
 
1604
- # Statistics of the DataDiscoveryScan.
1604
+ # Describes result statistics of a data scan discovery job.
1605
1605
  # Corresponds to the JSON property `scanStatistics`
1606
1606
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDiscoveryResultScanStatistics]
1607
1607
  attr_accessor :scan_statistics
@@ -1642,7 +1642,7 @@ module Google
1642
1642
  end
1643
1643
  end
1644
1644
 
1645
- # Statistics of the DataDiscoveryScan.
1645
+ # Describes result statistics of a data scan discovery job.
1646
1646
  class GoogleCloudDataplexV1DataDiscoveryResultScanStatistics
1647
1647
  include Google::Apis::Core::Hashable
1648
1648
 
@@ -4235,6 +4235,92 @@ module Google
4235
4235
  end
4236
4236
  end
4237
4237
 
4238
+ # A Resource designed to manage encryption configurations for customers to
4239
+ # support Customer Managed Encryption Keys (CMEK).
4240
+ class GoogleCloudDataplexV1EncryptionConfig
4241
+ include Google::Apis::Core::Hashable
4242
+
4243
+ # Output only. The time when the Encryption configuration was created.
4244
+ # Corresponds to the JSON property `createTime`
4245
+ # @return [String]
4246
+ attr_accessor :create_time
4247
+
4248
+ # Output only. The state of encryption of the databases.
4249
+ # Corresponds to the JSON property `encryptionState`
4250
+ # @return [String]
4251
+ attr_accessor :encryption_state
4252
+
4253
+ # Etag of the EncryptionConfig. This is a strong etag.
4254
+ # Corresponds to the JSON property `etag`
4255
+ # @return [String]
4256
+ attr_accessor :etag
4257
+
4258
+ # Details of the failure if anything related to Cmek db fails.
4259
+ # Corresponds to the JSON property `failureDetails`
4260
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EncryptionConfigFailureDetails]
4261
+ attr_accessor :failure_details
4262
+
4263
+ # Optional. If a key is chosen, it means that the customer is using CMEK. If a
4264
+ # key is not chosen, it means that the customer is using Google managed
4265
+ # encryption.
4266
+ # Corresponds to the JSON property `key`
4267
+ # @return [String]
4268
+ attr_accessor :key
4269
+
4270
+ # Identifier. The resource name of the EncryptionConfig. Format: organizations/`
4271
+ # organization`/locations/`location`/encryptionConfigs/`encryption_config`
4272
+ # Global location is not supported.
4273
+ # Corresponds to the JSON property `name`
4274
+ # @return [String]
4275
+ attr_accessor :name
4276
+
4277
+ # Output only. The time when the Encryption configuration was last updated.
4278
+ # Corresponds to the JSON property `updateTime`
4279
+ # @return [String]
4280
+ attr_accessor :update_time
4281
+
4282
+ def initialize(**args)
4283
+ update!(**args)
4284
+ end
4285
+
4286
+ # Update properties of this object
4287
+ def update!(**args)
4288
+ @create_time = args[:create_time] if args.key?(:create_time)
4289
+ @encryption_state = args[:encryption_state] if args.key?(:encryption_state)
4290
+ @etag = args[:etag] if args.key?(:etag)
4291
+ @failure_details = args[:failure_details] if args.key?(:failure_details)
4292
+ @key = args[:key] if args.key?(:key)
4293
+ @name = args[:name] if args.key?(:name)
4294
+ @update_time = args[:update_time] if args.key?(:update_time)
4295
+ end
4296
+ end
4297
+
4298
+ # Details of the failure if anything related to Cmek db fails.
4299
+ class GoogleCloudDataplexV1EncryptionConfigFailureDetails
4300
+ include Google::Apis::Core::Hashable
4301
+
4302
+ # Output only. The error code for the failure.
4303
+ # Corresponds to the JSON property `errorCode`
4304
+ # @return [String]
4305
+ attr_accessor :error_code
4306
+
4307
+ # Output only. The error message will be shown to the user. Set only if the
4308
+ # error code is REQUIRE_USER_ACTION.
4309
+ # Corresponds to the JSON property `errorMessage`
4310
+ # @return [String]
4311
+ attr_accessor :error_message
4312
+
4313
+ def initialize(**args)
4314
+ update!(**args)
4315
+ end
4316
+
4317
+ # Update properties of this object
4318
+ def update!(**args)
4319
+ @error_code = args[:error_code] if args.key?(:error_code)
4320
+ @error_message = args[:error_message] if args.key?(:error_message)
4321
+ end
4322
+ end
4323
+
4238
4324
  # Represents tables and fileset metadata contained within a zone.
4239
4325
  class GoogleCloudDataplexV1Entity
4240
4326
  include Google::Apis::Core::Hashable
@@ -4573,6 +4659,88 @@ module Google
4573
4659
  end
4574
4660
  end
4575
4661
 
4662
+ # EntryLink represents a link between two entries.
4663
+ class GoogleCloudDataplexV1EntryLink
4664
+ include Google::Apis::Core::Hashable
4665
+
4666
+ # Output only. The time when the Entry Link was created.
4667
+ # Corresponds to the JSON property `createTime`
4668
+ # @return [String]
4669
+ attr_accessor :create_time
4670
+
4671
+ # Required. Immutable. Relative resource name of the Entry Link Type used to
4672
+ # create this Entry Link, of the form: projects/`project`/locations/`location`/
4673
+ # entryLinkTypes/`entry_link_type`.
4674
+ # Corresponds to the JSON property `entryLinkType`
4675
+ # @return [String]
4676
+ attr_accessor :entry_link_type
4677
+
4678
+ # Required. Specifies the entries referenced in the entry link. There should be
4679
+ # exactly two entry references.
4680
+ # Corresponds to the JSON property `entryReferences`
4681
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryLinkEntryReference>]
4682
+ attr_accessor :entry_references
4683
+
4684
+ # Output only. Immutable. Identifier. The relative resource name of the Entry
4685
+ # Link, of the form: projects/`project`/locations/`location`/entryGroups/`
4686
+ # entry_group`/entryLinks/`entry_link`.
4687
+ # Corresponds to the JSON property `name`
4688
+ # @return [String]
4689
+ attr_accessor :name
4690
+
4691
+ # Output only. The time when the Entry Link was last updated.
4692
+ # Corresponds to the JSON property `updateTime`
4693
+ # @return [String]
4694
+ attr_accessor :update_time
4695
+
4696
+ def initialize(**args)
4697
+ update!(**args)
4698
+ end
4699
+
4700
+ # Update properties of this object
4701
+ def update!(**args)
4702
+ @create_time = args[:create_time] if args.key?(:create_time)
4703
+ @entry_link_type = args[:entry_link_type] if args.key?(:entry_link_type)
4704
+ @entry_references = args[:entry_references] if args.key?(:entry_references)
4705
+ @name = args[:name] if args.key?(:name)
4706
+ @update_time = args[:update_time] if args.key?(:update_time)
4707
+ end
4708
+ end
4709
+
4710
+ # Reference to the Entry that is linked through the entry link.
4711
+ class GoogleCloudDataplexV1EntryLinkEntryReference
4712
+ include Google::Apis::Core::Hashable
4713
+
4714
+ # Required. Immutable. The relative resource name of the referenced entry, of
4715
+ # the form: projects/`project`/locations/`location`/entryGroups/`entryGroup`/
4716
+ # entries/`entry`.
4717
+ # Corresponds to the JSON property `name`
4718
+ # @return [String]
4719
+ attr_accessor :name
4720
+
4721
+ # Immutable. The path in the entry that is referenced in the entry link. Empty
4722
+ # path denotes that the entry itself is referenced in the entry link.
4723
+ # Corresponds to the JSON property `path`
4724
+ # @return [String]
4725
+ attr_accessor :path
4726
+
4727
+ # Required. Immutable. The reference type of the entry.
4728
+ # Corresponds to the JSON property `type`
4729
+ # @return [String]
4730
+ attr_accessor :type
4731
+
4732
+ def initialize(**args)
4733
+ update!(**args)
4734
+ end
4735
+
4736
+ # Update properties of this object
4737
+ def update!(**args)
4738
+ @name = args[:name] if args.key?(:name)
4739
+ @path = args[:path] if args.key?(:path)
4740
+ @type = args[:type] if args.key?(:type)
4741
+ end
4742
+ end
4743
+
4576
4744
  # Payload associated with Entry related log events.
4577
4745
  class GoogleCloudDataplexV1EntryLinkEvent
4578
4746
  include Google::Apis::Core::Hashable
@@ -5151,6 +5319,227 @@ module Google
5151
5319
  end
5152
5320
  end
5153
5321
 
5322
+ # A Glossary represents a collection of categories and terms defined by the user.
5323
+ # Glossary is a top level resource and is the GCP parent resource of all the
5324
+ # categories and terms within it.
5325
+ class GoogleCloudDataplexV1Glossary
5326
+ include Google::Apis::Core::Hashable
5327
+
5328
+ # Output only. The number of categories in the glossary.
5329
+ # Corresponds to the JSON property `categoryCount`
5330
+ # @return [Fixnum]
5331
+ attr_accessor :category_count
5332
+
5333
+ # Output only. The time at which the glossary was created.
5334
+ # Corresponds to the JSON property `createTime`
5335
+ # @return [String]
5336
+ attr_accessor :create_time
5337
+
5338
+ # Optional. The user-mutable description of the glossary.
5339
+ # Corresponds to the JSON property `description`
5340
+ # @return [String]
5341
+ attr_accessor :description
5342
+
5343
+ # Optional. User friendly display name of the glossary. This is user-mutable.
5344
+ # This will be same as the glossaryId, if not specified.
5345
+ # Corresponds to the JSON property `displayName`
5346
+ # @return [String]
5347
+ attr_accessor :display_name
5348
+
5349
+ # Optional. Needed for resource freshness validation. This checksum is computed
5350
+ # by the server based on the value of other fields, and may be sent on update
5351
+ # and delete requests to ensure the client has an up-to-date value before
5352
+ # proceeding.
5353
+ # Corresponds to the JSON property `etag`
5354
+ # @return [String]
5355
+ attr_accessor :etag
5356
+
5357
+ # Optional. User-defined labels for the Glossary.
5358
+ # Corresponds to the JSON property `labels`
5359
+ # @return [Hash<String,String>]
5360
+ attr_accessor :labels
5361
+
5362
+ # Output only. Identifier. The resource name of the Glossary. Format: projects/`
5363
+ # projectId`/locations/`locationId`/glossaries/`glossaryId`
5364
+ # Corresponds to the JSON property `name`
5365
+ # @return [String]
5366
+ attr_accessor :name
5367
+
5368
+ # Output only. The number of terms in the glossary.
5369
+ # Corresponds to the JSON property `termCount`
5370
+ # @return [Fixnum]
5371
+ attr_accessor :term_count
5372
+
5373
+ # Output only. System generated unique id for the Glossary. This ID will be
5374
+ # different if the Glossary is deleted and re-created with the same name.
5375
+ # Corresponds to the JSON property `uid`
5376
+ # @return [String]
5377
+ attr_accessor :uid
5378
+
5379
+ # Output only. The time at which the glossary was last updated.
5380
+ # Corresponds to the JSON property `updateTime`
5381
+ # @return [String]
5382
+ attr_accessor :update_time
5383
+
5384
+ def initialize(**args)
5385
+ update!(**args)
5386
+ end
5387
+
5388
+ # Update properties of this object
5389
+ def update!(**args)
5390
+ @category_count = args[:category_count] if args.key?(:category_count)
5391
+ @create_time = args[:create_time] if args.key?(:create_time)
5392
+ @description = args[:description] if args.key?(:description)
5393
+ @display_name = args[:display_name] if args.key?(:display_name)
5394
+ @etag = args[:etag] if args.key?(:etag)
5395
+ @labels = args[:labels] if args.key?(:labels)
5396
+ @name = args[:name] if args.key?(:name)
5397
+ @term_count = args[:term_count] if args.key?(:term_count)
5398
+ @uid = args[:uid] if args.key?(:uid)
5399
+ @update_time = args[:update_time] if args.key?(:update_time)
5400
+ end
5401
+ end
5402
+
5403
+ # A GlossaryCategory represents a collection of categories and terms within a
5404
+ # Glossary that are related to each other.
5405
+ class GoogleCloudDataplexV1GlossaryCategory
5406
+ include Google::Apis::Core::Hashable
5407
+
5408
+ # Output only. The time at which the GlossaryCategory was created.
5409
+ # Corresponds to the JSON property `createTime`
5410
+ # @return [String]
5411
+ attr_accessor :create_time
5412
+
5413
+ # Optional. The user-mutable description of the GlossaryCategory.
5414
+ # Corresponds to the JSON property `description`
5415
+ # @return [String]
5416
+ attr_accessor :description
5417
+
5418
+ # Optional. User friendly display name of the GlossaryCategory. This is user-
5419
+ # mutable. This will be same as the categoryId, if not specified.
5420
+ # Corresponds to the JSON property `displayName`
5421
+ # @return [String]
5422
+ attr_accessor :display_name
5423
+
5424
+ # Optional. User-defined labels for the GlossaryCategory.
5425
+ # Corresponds to the JSON property `labels`
5426
+ # @return [Hash<String,String>]
5427
+ attr_accessor :labels
5428
+
5429
+ # Output only. Identifier. The resource name of the GlossaryCategory. Format:
5430
+ # projects/`projectId`/locations/`locationId`/glossaries/`glossaryId`/categories/
5431
+ # `categoryId`
5432
+ # Corresponds to the JSON property `name`
5433
+ # @return [String]
5434
+ attr_accessor :name
5435
+
5436
+ # Required. The immediate parent of the GlossaryCategory in the resource-
5437
+ # hierarchy. It can either be a Glossary or a Category. Format: projects/`
5438
+ # projectId`/locations/`locationId`/glossaries/`glossaryId` OR projects/`
5439
+ # projectId`/locations/`locationId`/glossaries/`glossaryId`/categories/`
5440
+ # categoryId`
5441
+ # Corresponds to the JSON property `parent`
5442
+ # @return [String]
5443
+ attr_accessor :parent
5444
+
5445
+ # Output only. System generated unique id for the GlossaryCategory. This ID will
5446
+ # be different if the GlossaryCategory is deleted and re-created with the same
5447
+ # name.
5448
+ # Corresponds to the JSON property `uid`
5449
+ # @return [String]
5450
+ attr_accessor :uid
5451
+
5452
+ # Output only. The time at which the GlossaryCategory was last updated.
5453
+ # Corresponds to the JSON property `updateTime`
5454
+ # @return [String]
5455
+ attr_accessor :update_time
5456
+
5457
+ def initialize(**args)
5458
+ update!(**args)
5459
+ end
5460
+
5461
+ # Update properties of this object
5462
+ def update!(**args)
5463
+ @create_time = args[:create_time] if args.key?(:create_time)
5464
+ @description = args[:description] if args.key?(:description)
5465
+ @display_name = args[:display_name] if args.key?(:display_name)
5466
+ @labels = args[:labels] if args.key?(:labels)
5467
+ @name = args[:name] if args.key?(:name)
5468
+ @parent = args[:parent] if args.key?(:parent)
5469
+ @uid = args[:uid] if args.key?(:uid)
5470
+ @update_time = args[:update_time] if args.key?(:update_time)
5471
+ end
5472
+ end
5473
+
5474
+ # GlossaryTerms are the core of glossary. A GlossaryTerm holds a rich text
5475
+ # description that can be attached to entries or specific columns to enrich them.
5476
+ class GoogleCloudDataplexV1GlossaryTerm
5477
+ include Google::Apis::Core::Hashable
5478
+
5479
+ # Output only. The time at which the GlossaryTerm was created.
5480
+ # Corresponds to the JSON property `createTime`
5481
+ # @return [String]
5482
+ attr_accessor :create_time
5483
+
5484
+ # Optional. The user-mutable description of the GlossaryTerm.
5485
+ # Corresponds to the JSON property `description`
5486
+ # @return [String]
5487
+ attr_accessor :description
5488
+
5489
+ # Optional. User friendly display name of the GlossaryTerm. This is user-mutable.
5490
+ # This will be same as the termId, if not specified.
5491
+ # Corresponds to the JSON property `displayName`
5492
+ # @return [String]
5493
+ attr_accessor :display_name
5494
+
5495
+ # Optional. User-defined labels for the GlossaryTerm.
5496
+ # Corresponds to the JSON property `labels`
5497
+ # @return [Hash<String,String>]
5498
+ attr_accessor :labels
5499
+
5500
+ # Output only. Identifier. The resource name of the GlossaryTerm. Format:
5501
+ # projects/`projectId`/locations/`locationId`/glossaries/`glossaryId`/terms/`
5502
+ # termId`
5503
+ # Corresponds to the JSON property `name`
5504
+ # @return [String]
5505
+ attr_accessor :name
5506
+
5507
+ # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy.
5508
+ # It can either be a Glossary or a Category. Format: projects/`projectId`/
5509
+ # locations/`locationId`/glossaries/`glossaryId` OR projects/`projectId`/
5510
+ # locations/`locationId`/glossaries/`glossaryId`/categories/`categoryId`
5511
+ # Corresponds to the JSON property `parent`
5512
+ # @return [String]
5513
+ attr_accessor :parent
5514
+
5515
+ # Output only. System generated unique id for the GlossaryTerm. This ID will be
5516
+ # different if the GlossaryTerm is deleted and re-created with the same name.
5517
+ # Corresponds to the JSON property `uid`
5518
+ # @return [String]
5519
+ attr_accessor :uid
5520
+
5521
+ # Output only. The time at which the GlossaryTerm was last updated.
5522
+ # Corresponds to the JSON property `updateTime`
5523
+ # @return [String]
5524
+ attr_accessor :update_time
5525
+
5526
+ def initialize(**args)
5527
+ update!(**args)
5528
+ end
5529
+
5530
+ # Update properties of this object
5531
+ def update!(**args)
5532
+ @create_time = args[:create_time] if args.key?(:create_time)
5533
+ @description = args[:description] if args.key?(:description)
5534
+ @display_name = args[:display_name] if args.key?(:display_name)
5535
+ @labels = args[:labels] if args.key?(:labels)
5536
+ @name = args[:name] if args.key?(:name)
5537
+ @parent = args[:parent] if args.key?(:parent)
5538
+ @uid = args[:uid] if args.key?(:uid)
5539
+ @update_time = args[:update_time] if args.key?(:update_time)
5540
+ end
5541
+ end
5542
+
5154
5543
  # Payload associated with Governance related log events.
5155
5544
  class GoogleCloudDataplexV1GovernanceEvent
5156
5545
  include Google::Apis::Core::Hashable
@@ -5847,6 +6236,38 @@ module Google
5847
6236
  end
5848
6237
  end
5849
6238
 
6239
+ # List EncryptionConfigs Response
6240
+ class GoogleCloudDataplexV1ListEncryptionConfigsResponse
6241
+ include Google::Apis::Core::Hashable
6242
+
6243
+ # The list of EncryptionConfigs under the given parent location.
6244
+ # Corresponds to the JSON property `encryptionConfigs`
6245
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EncryptionConfig>]
6246
+ attr_accessor :encryption_configs
6247
+
6248
+ # Token to retrieve the next page of results, or empty if there are no more
6249
+ # results in the list.
6250
+ # Corresponds to the JSON property `nextPageToken`
6251
+ # @return [String]
6252
+ attr_accessor :next_page_token
6253
+
6254
+ # Locations that could not be reached.
6255
+ # Corresponds to the JSON property `unreachableLocations`
6256
+ # @return [Array<String>]
6257
+ attr_accessor :unreachable_locations
6258
+
6259
+ def initialize(**args)
6260
+ update!(**args)
6261
+ end
6262
+
6263
+ # Update properties of this object
6264
+ def update!(**args)
6265
+ @encryption_configs = args[:encryption_configs] if args.key?(:encryption_configs)
6266
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6267
+ @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
6268
+ end
6269
+ end
6270
+
5850
6271
  # List metadata entities response.
5851
6272
  class GoogleCloudDataplexV1ListEntitiesResponse
5852
6273
  include Google::Apis::Core::Hashable
@@ -5989,6 +6410,102 @@ module Google
5989
6410
  end
5990
6411
  end
5991
6412
 
6413
+ # List Glossaries Response
6414
+ class GoogleCloudDataplexV1ListGlossariesResponse
6415
+ include Google::Apis::Core::Hashable
6416
+
6417
+ # Lists the glossaries in the specified parent.
6418
+ # Corresponds to the JSON property `glossaries`
6419
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1Glossary>]
6420
+ attr_accessor :glossaries
6421
+
6422
+ # A token, which can be sent as page_token to retrieve the next page. If this
6423
+ # field is omitted, there are no subsequent pages.
6424
+ # Corresponds to the JSON property `nextPageToken`
6425
+ # @return [String]
6426
+ attr_accessor :next_page_token
6427
+
6428
+ # Locations that the service couldn't reach.
6429
+ # Corresponds to the JSON property `unreachableLocations`
6430
+ # @return [Array<String>]
6431
+ attr_accessor :unreachable_locations
6432
+
6433
+ def initialize(**args)
6434
+ update!(**args)
6435
+ end
6436
+
6437
+ # Update properties of this object
6438
+ def update!(**args)
6439
+ @glossaries = args[:glossaries] if args.key?(:glossaries)
6440
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6441
+ @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
6442
+ end
6443
+ end
6444
+
6445
+ # List GlossaryCategories Response
6446
+ class GoogleCloudDataplexV1ListGlossaryCategoriesResponse
6447
+ include Google::Apis::Core::Hashable
6448
+
6449
+ # Lists the glossaryCategories in the specified parent.
6450
+ # Corresponds to the JSON property `categories`
6451
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryCategory>]
6452
+ attr_accessor :categories
6453
+
6454
+ # A token, which can be sent as page_token to retrieve the next page. If this
6455
+ # field is omitted, there are no subsequent pages.
6456
+ # Corresponds to the JSON property `nextPageToken`
6457
+ # @return [String]
6458
+ attr_accessor :next_page_token
6459
+
6460
+ # Locations that the service couldn't reach.
6461
+ # Corresponds to the JSON property `unreachableLocations`
6462
+ # @return [Array<String>]
6463
+ attr_accessor :unreachable_locations
6464
+
6465
+ def initialize(**args)
6466
+ update!(**args)
6467
+ end
6468
+
6469
+ # Update properties of this object
6470
+ def update!(**args)
6471
+ @categories = args[:categories] if args.key?(:categories)
6472
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6473
+ @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
6474
+ end
6475
+ end
6476
+
6477
+ # List GlossaryTerms Response
6478
+ class GoogleCloudDataplexV1ListGlossaryTermsResponse
6479
+ include Google::Apis::Core::Hashable
6480
+
6481
+ # A token, which can be sent as page_token to retrieve the next page. If this
6482
+ # field is omitted, there are no subsequent pages.
6483
+ # Corresponds to the JSON property `nextPageToken`
6484
+ # @return [String]
6485
+ attr_accessor :next_page_token
6486
+
6487
+ # Lists the terms in the specified parent.
6488
+ # Corresponds to the JSON property `terms`
6489
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1GlossaryTerm>]
6490
+ attr_accessor :terms
6491
+
6492
+ # Locations that the service couldn't reach.
6493
+ # Corresponds to the JSON property `unreachableLocations`
6494
+ # @return [Array<String>]
6495
+ attr_accessor :unreachable_locations
6496
+
6497
+ def initialize(**args)
6498
+ update!(**args)
6499
+ end
6500
+
6501
+ # Update properties of this object
6502
+ def update!(**args)
6503
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6504
+ @terms = args[:terms] if args.key?(:terms)
6505
+ @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
6506
+ end
6507
+ end
6508
+
5992
6509
  # List jobs response.
5993
6510
  class GoogleCloudDataplexV1ListJobsResponse
5994
6511
  include Google::Apis::Core::Hashable
@@ -6198,13 +6715,14 @@ module Google
6198
6715
  # @return [String]
6199
6716
  attr_accessor :create_time
6200
6717
 
6201
- # Export Job Results. The result is based on the snapshot at the time when the
6202
- # job is created.
6718
+ # Summary results from a metadata export job. The results are a snapshot of the
6719
+ # metadata at the time when the job was created. The exported entries are saved
6720
+ # to a Cloud Storage bucket.
6203
6721
  # Corresponds to the JSON property `exportResult`
6204
6722
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJobExportJobResult]
6205
6723
  attr_accessor :export_result
6206
6724
 
6207
- # Export job specification.
6725
+ # Job specification for a metadata export job.
6208
6726
  # Corresponds to the JSON property `exportSpec`
6209
6727
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJobExportJobSpec]
6210
6728
  attr_accessor :export_spec
@@ -6278,17 +6796,18 @@ module Google
6278
6796
  end
6279
6797
  end
6280
6798
 
6281
- # Export Job Results. The result is based on the snapshot at the time when the
6282
- # job is created.
6799
+ # Summary results from a metadata export job. The results are a snapshot of the
6800
+ # metadata at the time when the job was created. The exported entries are saved
6801
+ # to a Cloud Storage bucket.
6283
6802
  class GoogleCloudDataplexV1MetadataJobExportJobResult
6284
6803
  include Google::Apis::Core::Hashable
6285
6804
 
6286
- # Output only. The error message if the export job failed.
6805
+ # Output only. The error message if the metadata export job failed.
6287
6806
  # Corresponds to the JSON property `errorMessage`
6288
6807
  # @return [String]
6289
6808
  attr_accessor :error_message
6290
6809
 
6291
- # Output only. The number of entries that have been exported.
6810
+ # Output only. The number of entries that were exported.
6292
6811
  # Corresponds to the JSON property `exportedEntries`
6293
6812
  # @return [Fixnum]
6294
6813
  attr_accessor :exported_entries
@@ -6304,19 +6823,22 @@ module Google
6304
6823
  end
6305
6824
  end
6306
6825
 
6307
- # Export job specification.
6826
+ # Job specification for a metadata export job.
6308
6827
  class GoogleCloudDataplexV1MetadataJobExportJobSpec
6309
6828
  include Google::Apis::Core::Hashable
6310
6829
 
6311
- # Required. The root path of the exported metadata. Must be in the format: "gs://
6312
- # " Or specify a customized prefix after the bucket: "gs://///.../". The length
6313
- # limit of the customized prefix is 128 characters. The bucket must be in the
6314
- # same VPC-SC perimeter with the job.
6830
+ # Required. The root path of the Cloud Storage bucket to export the metadata to,
6831
+ # in the format gs://`bucket`/. You can optionally specify a custom prefix after
6832
+ # the bucket name, in the format gs://`bucket`/`prefix`/. The maximum length of
6833
+ # the custom prefix is 128 characters. Dataplex constructs the object path for
6834
+ # the exported files by using the bucket name and prefix that you provide,
6835
+ # followed by a system-generated path.The bucket must be in the same VPC Service
6836
+ # Controls perimeter as the job.
6315
6837
  # Corresponds to the JSON property `outputPath`
6316
6838
  # @return [String]
6317
6839
  attr_accessor :output_path
6318
6840
 
6319
- # Scope of the export job.
6841
+ # The scope of the export job.
6320
6842
  # Corresponds to the JSON property `scope`
6321
6843
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope]
6322
6844
  attr_accessor :scope
@@ -6332,49 +6854,54 @@ module Google
6332
6854
  end
6333
6855
  end
6334
6856
 
6335
- # Scope of the export job.
6857
+ # The scope of the export job.
6336
6858
  class GoogleCloudDataplexV1MetadataJobExportJobSpecExportJobScope
6337
6859
  include Google::Apis::Core::Hashable
6338
6860
 
6339
- # The aspect types that are in scope for the export job. Optional. If specified,
6340
- # only aspects of the specified types will be affected by the job. Must follow
6341
- # the format: "projects//locations//aspectTypes/"
6861
+ # The aspect types that are in scope for the export job, specified as relative
6862
+ # resource names in the format projects/`project_id_or_number`/locations/`
6863
+ # location`/aspectTypes/`aspect_type_id`. Only aspects that belong to the
6864
+ # specified aspect types are affected by the job.
6342
6865
  # Corresponds to the JSON property `aspectTypes`
6343
6866
  # @return [Array<String>]
6344
6867
  attr_accessor :aspect_types
6345
6868
 
6346
- # The entry groups that are in scope for the export job. Optional. If specified,
6347
- # only entries in the specified entry groups will be exported by the job. Must
6348
- # be in the VPC-SC perimeter of the job. The location of the entry groups must
6349
- # be the same as the job. Either projects or entry_groups can be specified when
6350
- # organization_level_export is set to false. Must follow the format: "projects//
6351
- # locations//entryGroups/"
6869
+ # The entry groups whose metadata you want to export, in the format projects/`
6870
+ # project_id_or_number`/locations/`location_id`/entryGroups/`entry_group_id`.
6871
+ # Only the entries in the specified entry groups are exported.The entry groups
6872
+ # must be in the same location and the same VPC Service Controls perimeter as
6873
+ # the job.If you set the job scope to be a list of entry groups, then set the
6874
+ # organization-level export flag to false and don't provide a list of projects.
6352
6875
  # Corresponds to the JSON property `entryGroups`
6353
6876
  # @return [Array<String>]
6354
6877
  attr_accessor :entry_groups
6355
6878
 
6356
- # If specified, only entries of the specified types will be affected by the job.
6357
- # Must follow the format: "projects//locations//entryTypes/"
6879
+ # The entry types that are in scope for the export job, specified as relative
6880
+ # resource names in the format projects/`project_id_or_number`/locations/`
6881
+ # location`/entryTypes/`entry_type_id`. Only entries that belong to the
6882
+ # specified entry types are affected by the job.
6358
6883
  # Corresponds to the JSON property `entryTypes`
6359
6884
  # @return [Array<String>]
6360
6885
  attr_accessor :entry_types
6361
6886
 
6362
- # Indicating if it is an organization level export job. - When set to true,
6363
- # exports all entries from entry groups and projects sharing the same
6364
- # organization id of the Metadata Job. Only projects and entry groups in the VPC-
6365
- # SC perimeter will be exported. The projects and entry groups are ignored. -
6366
- # When set to false, one of the projects or entry groups must be specified. -
6367
- # Default to false.
6887
+ # Whether the metadata export job is an organization-level export job. If true,
6888
+ # the job exports the entries from the same organization and VPC Service
6889
+ # Controls perimeter as the job. The project that the job belongs to determines
6890
+ # the VPC Service Controls perimeter. If you set the job scope to be at the
6891
+ # organization level, then don't provide a list of projects or entry groups. If
6892
+ # false, you must specify a list of projects or a list of entry groups whose
6893
+ # entries you want to export.The default is false.
6368
6894
  # Corresponds to the JSON property `organizationLevel`
6369
6895
  # @return [Boolean]
6370
6896
  attr_accessor :organization_level
6371
6897
  alias_method :organization_level?, :organization_level
6372
6898
 
6373
- # The projects that are in the scope of the export job. Can either be project
6374
- # numbers or project IDs. If specified, only the entries from the specified
6375
- # projects will be exported. The projects must be in the same organization and
6376
- # in the VPC-SC perimeter. Either projects or entry_groups can be specified when
6377
- # organization_level_export is set to false. Must follow the format: "projects/"
6899
+ # The projects whose metadata you want to export, in the format projects/`
6900
+ # project_id_or_number`. Only the entries from the specified projects are
6901
+ # exported.The projects must be in the same organization and VPC Service
6902
+ # Controls perimeter as the job.If you set the job scope to be a list of
6903
+ # projects, then set the organization-level export flag to false and don't
6904
+ # provide a list of entry groups.
6378
6905
  # Corresponds to the JSON property `projects`
6379
6906
  # @return [Array<String>]
6380
6907
  attr_accessor :projects
@@ -6484,15 +7011,15 @@ module Google
6484
7011
  # Optional. The URI of a Cloud Storage bucket or folder (beginning with gs://
6485
7012
  # and ending with /) that contains the metadata import files for this job.A
6486
7013
  # metadata import file defines the values to set for each of the entries and
6487
- # aspects in a metadata job. For more information about how to create a metadata
6488
- # import file and the file requirements, see Metadata import file (https://cloud.
6489
- # google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide
6490
- # multiple metadata import files in the same metadata job. The bucket or folder
6491
- # must contain at least one metadata import file, in JSON Lines format (either .
6492
- # json or .jsonl file extension).In FULL entry sync mode, don't save the
6493
- # metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution:
6494
- # If the metadata import file contains no data, all entries and aspects that
6495
- # belong to the job's scope are deleted.
7014
+ # aspects in a metadata import job. For more information about how to create a
7015
+ # metadata import file and the file requirements, see Metadata import file (
7016
+ # https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
7017
+ # You can provide multiple metadata import files in the same metadata job. The
7018
+ # bucket or folder must contain at least one metadata import file, in JSON Lines
7019
+ # format (either .json or .jsonl file extension).In FULL entry sync mode, don't
7020
+ # save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.
7021
+ # Caution: If the metadata import file contains no data, all entries and aspects
7022
+ # that belong to the job's scope are deleted.
6496
7023
  # Corresponds to the JSON property `sourceStorageUri`
6497
7024
  # @return [String]
6498
7025
  attr_accessor :source_storage_uri