google-apis-dataplex_v1 0.57.0 → 0.59.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2684536c796761aa407a2c46be116c5758e9f40a070d8efd023c2d455637f4ab
4
- data.tar.gz: e16d43da403a58cb46e47f696552c3b003c33bd9bd422e3a57d676e751470365
3
+ metadata.gz: 02a92370ec790ff83e6f7a8a516edd1c9c546c5437f1ad66abb6acb0b001d9da
4
+ data.tar.gz: b3a6035e5f39de9b5d0f0f29d66f5919c341d8509f8fa2c6dbe3f75858ab69d0
5
5
  SHA512:
6
- metadata.gz: 046c0369883154b5bfb13557457af458b17ac8c6613ae78b1e71760f4a67f0db5578d34b95c29fc65bf500bf1f90e40396eced3466eae7a5654f526730198b97
7
- data.tar.gz: 7b7cb5bd01f77c10a599b517343ea03902252960b6a0f339668354f618bf3793081894008a8f1bd2f11cc2a5b153c507130d2a06e25845989d6b7459c2265271
6
+ metadata.gz: 3c22fab90d23c2be502fa1a878f92f42248560e7259776183bd8f3c88125c7276466762397caf3402e44dfd1a11baab2e4d9f744e95f664a9c41e30bb781c181
7
+ data.tar.gz: 77921d96a7ba3dbb7dd294f964c37ec6f498600cc50f9ba7096ad3b17731f3574f01e04db75d7c55874c9e150e482a77e20003fee5ee032b29ce50d966449116
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-dataplex_v1
2
2
 
3
+ ### v0.59.0 (2024-07-25)
4
+
5
+ * Regenerated from discovery document revision 20240624
6
+
7
+ ### v0.58.0 (2024-06-16)
8
+
9
+ * Regenerated from discovery document revision 20240611
10
+
3
11
  ### v0.57.0 (2024-06-02)
4
12
 
5
13
  * Regenerated from discovery document revision 20240523
@@ -337,7 +337,7 @@ module Google
337
337
  class GoogleCloudDataplexV1Aspect
338
338
  include Google::Apis::Core::Hashable
339
339
 
340
- # AspectSource contains source system related information for the aspect.
340
+ # AspectSource contains information related to the source system of the Aspect.
341
341
  # Corresponds to the JSON property `aspectSource`
342
342
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectSource]
343
343
  attr_accessor :aspect_source
@@ -352,9 +352,8 @@ module Google
352
352
  # @return [String]
353
353
  attr_accessor :create_time
354
354
 
355
- # Required. The content of the aspect, according to its aspect type schema. This
356
- # will replace content. The maximum size of the field is 120KB (encoded as UTF-8)
357
- # .
355
+ # Required. The content of the aspect, according to its aspect type schema. The
356
+ # maximum size of the field is 120KB (encoded as UTF-8).
358
357
  # Corresponds to the JSON property `data`
359
358
  # @return [Hash<String,Object>]
360
359
  attr_accessor :data
@@ -384,7 +383,7 @@ module Google
384
383
  end
385
384
  end
386
385
 
387
- # AspectSource contains source system related information for the aspect.
386
+ # AspectSource contains information related to the source system of the Aspect.
388
387
  class GoogleCloudDataplexV1AspectSource
389
388
  include Google::Apis::Core::Hashable
390
389
 
@@ -409,12 +408,12 @@ module Google
409
408
  end
410
409
  end
411
410
 
412
- # Aspect Type is a template for creating Aspects, and represents the JSON-schema
413
- # for a given Entry, e.g., BigQuery Table Schema.
411
+ # AspectType is a template for creating Aspects, and represents the JSON-schema
412
+ # for a given Entry, for example, BigQuery Table Schema.
414
413
  class GoogleCloudDataplexV1AspectType
415
414
  include Google::Apis::Core::Hashable
416
415
 
417
- # Autorization for an Aspect Type.
416
+ # Autorization for an AspectType.
418
417
  # Corresponds to the JSON property `authorization`
419
418
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeAuthorization]
420
419
  attr_accessor :authorization
@@ -434,9 +433,8 @@ module Google
434
433
  # @return [String]
435
434
  attr_accessor :display_name
436
435
 
437
- # This checksum is computed by the server based on the value of other fields,
438
- # and may be sent on update and delete requests to ensure the client has an up-
439
- # to-date value before proceeding.
436
+ # The service computes this checksum. The client may send it on update and
437
+ # delete requests to ensure it has an up-to-date value before proceeding.
440
438
  # Corresponds to the JSON property `etag`
441
439
  # @return [String]
442
440
  attr_accessor :etag
@@ -446,7 +444,7 @@ module Google
446
444
  # @return [Hash<String,String>]
447
445
  attr_accessor :labels
448
446
 
449
- # MetadataTemplate definition for AspectType
447
+ # MetadataTemplate definition for an AspectType.
450
448
  # Corresponds to the JSON property `metadataTemplate`
451
449
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate]
452
450
  attr_accessor :metadata_template
@@ -457,15 +455,9 @@ module Google
457
455
  # @return [String]
458
456
  attr_accessor :name
459
457
 
460
- # Output only. Denotes the transfer status of the Aspect Type. It is unspecified
461
- # for Aspect Types created from Dataplex API.
462
- # Corresponds to the JSON property `transferStatus`
463
- # @return [String]
464
- attr_accessor :transfer_status
465
-
466
- # Output only. System generated globally unique ID for the AspectType. This ID
467
- # will be different if the AspectType is deleted and re-created with the same
468
- # name.
458
+ # Output only. System generated globally unique ID for the AspectType. If you
459
+ # delete and recreate the AspectType with the same name, then this ID will be
460
+ # different.
469
461
  # Corresponds to the JSON property `uid`
470
462
  # @return [String]
471
463
  attr_accessor :uid
@@ -489,18 +481,17 @@ module Google
489
481
  @labels = args[:labels] if args.key?(:labels)
490
482
  @metadata_template = args[:metadata_template] if args.key?(:metadata_template)
491
483
  @name = args[:name] if args.key?(:name)
492
- @transfer_status = args[:transfer_status] if args.key?(:transfer_status)
493
484
  @uid = args[:uid] if args.key?(:uid)
494
485
  @update_time = args[:update_time] if args.key?(:update_time)
495
486
  end
496
487
  end
497
488
 
498
- # Autorization for an Aspect Type.
489
+ # Autorization for an AspectType.
499
490
  class GoogleCloudDataplexV1AspectTypeAuthorization
500
491
  include Google::Apis::Core::Hashable
501
492
 
502
- # Immutable. The IAM permission grantable on the Entry Group to allow access to
503
- # instantiate Aspects of Dataplex owned Aspect Types, only settable for Dataplex
493
+ # Immutable. The IAM permission grantable on the EntryGroup to allow access to
494
+ # instantiate Aspects of Dataplex owned AspectTypes, only settable for Dataplex
504
495
  # owned Types.
505
496
  # Corresponds to the JSON property `alternateUsePermission`
506
497
  # @return [String]
@@ -516,26 +507,26 @@ module Google
516
507
  end
517
508
  end
518
509
 
519
- # MetadataTemplate definition for AspectType
510
+ # MetadataTemplate definition for an AspectType.
520
511
  class GoogleCloudDataplexV1AspectTypeMetadataTemplate
521
512
  include Google::Apis::Core::Hashable
522
513
 
523
- # Definition of the annotations of a field
514
+ # Definition of the annotations of a field.
524
515
  # Corresponds to the JSON property `annotations`
525
516
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations]
526
517
  attr_accessor :annotations
527
518
 
528
- # MetadataTemplate definition for AspectType
519
+ # MetadataTemplate definition for an AspectType.
529
520
  # Corresponds to the JSON property `arrayItems`
530
521
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate]
531
522
  attr_accessor :array_items
532
523
 
533
- # Definition of the constraints of a field
524
+ # Definition of the constraints of a field.
534
525
  # Corresponds to the JSON property `constraints`
535
526
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints]
536
527
  attr_accessor :constraints
537
528
 
538
- # Optional. The list of values for an enum type. Needs to be defined if the type
529
+ # Optional. The list of values for an enum type. You must define it if the type
539
530
  # is enum.
540
531
  # Corresponds to the JSON property `enumValues`
541
532
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue>]
@@ -551,7 +542,7 @@ module Google
551
542
  # @return [Fixnum]
552
543
  attr_accessor :index
553
544
 
554
- # MetadataTemplate definition for AspectType
545
+ # MetadataTemplate definition for an AspectType.
555
546
  # Corresponds to the JSON property `mapItems`
556
547
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate]
557
548
  attr_accessor :map_items
@@ -561,31 +552,30 @@ module Google
561
552
  # @return [String]
562
553
  attr_accessor :name
563
554
 
564
- # Optional. Field definition, needs to be specified if the type is record.
565
- # Defines the nested fields.
555
+ # Optional. Field definition. You must specify it if the type is record. It
556
+ # defines the nested fields.
566
557
  # Corresponds to the JSON property `recordFields`
567
558
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate>]
568
559
  attr_accessor :record_fields
569
560
 
570
561
  # Required. The datatype of this field. The following values are supported:
571
- # Primitive types (string, integer, boolean, double, datetime); datetime must be
572
- # of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-
573
- # 10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record).
562
+ # Primitive types: string integer boolean double datetime. Must be of the format
563
+ # RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.
564
+ # 045123456Z").Complex types: enum array map record
574
565
  # Corresponds to the JSON property `type`
575
566
  # @return [String]
576
567
  attr_accessor :type
577
568
 
578
- # Optional. Id can be used if this definition of the field needs to be reused
579
- # later. Id needs to be unique across the entire template. Id can only be
580
- # specified if the field type is record.
569
+ # Optional. You can use type id if this definition of the field needs to be
570
+ # reused later. The type id must be unique across the entire template. You can
571
+ # only specify it if the field type is record.
581
572
  # Corresponds to the JSON property `typeId`
582
573
  # @return [String]
583
574
  attr_accessor :type_id
584
575
 
585
- # Optional. A reference to another field definition (instead of an inline
586
- # definition). The value must be equal to the value of an id field defined
587
- # elsewhere in the MetadataTemplate. Only fields with type as record can refer
588
- # to other fields.
576
+ # Optional. A reference to another field definition (not an inline definition).
577
+ # The value must be equal to the value of an id field defined elsewhere in the
578
+ # MetadataTemplate. Only fields with record type can refer to other fields.
589
579
  # Corresponds to the JSON property `typeRef`
590
580
  # @return [String]
591
581
  attr_accessor :type_ref
@@ -610,41 +600,41 @@ module Google
610
600
  end
611
601
  end
612
602
 
613
- # Definition of the annotations of a field
603
+ # Definition of the annotations of a field.
614
604
  class GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations
615
605
  include Google::Apis::Core::Hashable
616
606
 
617
- # Optional. Marks a field as deprecated, a deprecation message can be included.
607
+ # Optional. Marks a field as deprecated. You can include a deprecation message.
618
608
  # Corresponds to the JSON property `deprecated`
619
609
  # @return [String]
620
610
  attr_accessor :deprecated
621
611
 
622
- # Optional. Specify a description for a field
612
+ # Optional. Description for a field.
623
613
  # Corresponds to the JSON property `description`
624
614
  # @return [String]
625
615
  attr_accessor :description
626
616
 
627
- # Optional. Specify a displayname for a field.
617
+ # Optional. Display name for a field.
628
618
  # Corresponds to the JSON property `displayName`
629
619
  # @return [String]
630
620
  attr_accessor :display_name
631
621
 
632
- # Optional. Specify a display order for a field. Display order can be used to
633
- # reorder where a field is rendered
622
+ # Optional. Display order for a field. You can use this to reorder where a field
623
+ # is rendered.
634
624
  # Corresponds to the JSON property `displayOrder`
635
625
  # @return [Fixnum]
636
626
  attr_accessor :display_order
637
627
 
638
- # Optional. String Type annotations can be used to specify special meaning to
628
+ # Optional. You can use String Type annotations to specify special meaning to
639
629
  # string fields. The following values are supported: richText: The field must be
640
- # interpreted as a rich text field. url: A fully qualified url link. resource: A
630
+ # interpreted as a rich text field. url: A fully qualified URL link. resource: A
641
631
  # service qualified resource reference.
642
632
  # Corresponds to the JSON property `stringType`
643
633
  # @return [String]
644
634
  attr_accessor :string_type
645
635
 
646
- # Optional. Suggested hints for string fields. These can be used to suggest
647
- # values to users, through an UI for example.
636
+ # Optional. Suggested hints for string fields. You can use them to suggest
637
+ # values to users through console.
648
638
  # Corresponds to the JSON property `stringValues`
649
639
  # @return [Array<String>]
650
640
  attr_accessor :string_values
@@ -664,11 +654,11 @@ module Google
664
654
  end
665
655
  end
666
656
 
667
- # Definition of the constraints of a field
657
+ # Definition of the constraints of a field.
668
658
  class GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints
669
659
  include Google::Apis::Core::Hashable
670
660
 
671
- # Optional. Marks this as an optional/required field.
661
+ # Optional. Marks this field as optional or required.
672
662
  # Corresponds to the JSON property `required`
673
663
  # @return [Boolean]
674
664
  attr_accessor :required
@@ -684,22 +674,21 @@ module Google
684
674
  end
685
675
  end
686
676
 
687
- # Definition of Enumvalue (to be used by enum fields)
677
+ # Definition of Enumvalue, to be used for enum fields.
688
678
  class GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue
689
679
  include Google::Apis::Core::Hashable
690
680
 
691
- # Optional. Optional deprecation message to be set if an enum value needs to be
692
- # deprecated.
681
+ # Optional. You can set this message if you need to deprecate an enum value.
693
682
  # Corresponds to the JSON property `deprecated`
694
683
  # @return [String]
695
684
  attr_accessor :deprecated
696
685
 
697
- # Required. Index for the enum. Cannot be modified.
686
+ # Required. Index for the enum value. It can't be modified.
698
687
  # Corresponds to the JSON property `index`
699
688
  # @return [Fixnum]
700
689
  attr_accessor :index
701
690
 
702
- # Required. Name of the enumvalue. This is the actual value that the aspect will
691
+ # Required. Name of the enumvalue. This is the actual value that the aspect can
703
692
  # contain.
704
693
  # Corresponds to the JSON property `name`
705
694
  # @return [String]
@@ -3377,6 +3366,11 @@ module Google
3377
3366
  class GoogleCloudDataplexV1DataScanExecutionStatus
3378
3367
  include Google::Apis::Core::Hashable
3379
3368
 
3369
+ # Optional. The time when the DataScanJob execution was created.
3370
+ # Corresponds to the JSON property `latestJobCreateTime`
3371
+ # @return [String]
3372
+ attr_accessor :latest_job_create_time
3373
+
3380
3374
  # The time when the latest DataScanJob ended.
3381
3375
  # Corresponds to the JSON property `latestJobEndTime`
3382
3376
  # @return [String]
@@ -3393,6 +3387,7 @@ module Google
3393
3387
 
3394
3388
  # Update properties of this object
3395
3389
  def update!(**args)
3390
+ @latest_job_create_time = args[:latest_job_create_time] if args.key?(:latest_job_create_time)
3396
3391
  @latest_job_end_time = args[:latest_job_end_time] if args.key?(:latest_job_end_time)
3397
3392
  @latest_job_start_time = args[:latest_job_start_time] if args.key?(:latest_job_start_time)
3398
3393
  end
@@ -3402,6 +3397,11 @@ module Google
3402
3397
  class GoogleCloudDataplexV1DataScanJob
3403
3398
  include Google::Apis::Core::Hashable
3404
3399
 
3400
+ # Output only. The time when the DataScanJob was created.
3401
+ # Corresponds to the JSON property `createTime`
3402
+ # @return [String]
3403
+ attr_accessor :create_time
3404
+
3405
3405
  # DataProfileResult defines the output of DataProfileScan. Each field of the
3406
3406
  # table will have field type specific profile result.
3407
3407
  # Corresponds to the JSON property `dataProfileResult`
@@ -3467,6 +3467,7 @@ module Google
3467
3467
 
3468
3468
  # Update properties of this object
3469
3469
  def update!(**args)
3470
+ @create_time = args[:create_time] if args.key?(:create_time)
3470
3471
  @data_profile_result = args[:data_profile_result] if args.key?(:data_profile_result)
3471
3472
  @data_profile_spec = args[:data_profile_spec] if args.key?(:data_profile_spec)
3472
3473
  @data_quality_result = args[:data_quality_result] if args.key?(:data_quality_result)
@@ -3964,9 +3965,9 @@ module Google
3964
3965
  include Google::Apis::Core::Hashable
3965
3966
 
3966
3967
  # Optional. The Aspects attached to the Entry. The format for the key can be one
3967
- # of the following: 1. `projectId`.`locationId`.`aspectTypeId` (if the aspect is
3968
- # attached directly to the entry) 2. `projectId`.`locationId`.`aspectTypeId`@`
3969
- # path` (if the aspect is attached to an entry's path)
3968
+ # of the following: `projectId`.`locationId`.`aspectTypeId` (if the aspect is
3969
+ # attached directly to the entry) `projectId`.`locationId`.`aspectTypeId`@`path`
3970
+ # (if the aspect is attached to an entry's path)
3970
3971
  # Corresponds to the JSON property `aspects`
3971
3972
  # @return [Hash<String,Google::Apis::DataplexV1::GoogleCloudDataplexV1Aspect>]
3972
3973
  attr_accessor :aspects
@@ -3976,7 +3977,7 @@ module Google
3976
3977
  # @return [String]
3977
3978
  attr_accessor :create_time
3978
3979
 
3979
- # EntrySource contains source system related information for the entry.
3980
+ # EntrySource contains information related to the source system of the Entry.
3980
3981
  # Corresponds to the JSON property `entrySource`
3981
3982
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntrySource]
3982
3983
  attr_accessor :entry_source
@@ -4045,9 +4046,8 @@ module Google
4045
4046
  # @return [String]
4046
4047
  attr_accessor :display_name
4047
4048
 
4048
- # This checksum is computed by the server based on the value of other fields,
4049
- # and may be sent on update and delete requests to ensure the client has an up-
4050
- # to-date value before proceeding.
4049
+ # This checksum is computed by the service, and might be sent on update and
4050
+ # delete requests to ensure the client has an up-to-date value before proceeding.
4051
4051
  # Corresponds to the JSON property `etag`
4052
4052
  # @return [String]
4053
4053
  attr_accessor :etag
@@ -4063,15 +4063,9 @@ module Google
4063
4063
  # @return [String]
4064
4064
  attr_accessor :name
4065
4065
 
4066
- # Output only. Denotes the transfer status of the Entry Group. It is unspecified
4067
- # for Entry Group created from Dataplex API.
4068
- # Corresponds to the JSON property `transferStatus`
4069
- # @return [String]
4070
- attr_accessor :transfer_status
4071
-
4072
- # Output only. System generated globally unique ID for the EntryGroup. This ID
4073
- # will be different if the EntryGroup is deleted and re-created with the same
4074
- # name.
4066
+ # Output only. System generated globally unique ID for the EntryGroup. If you
4067
+ # delete and recreate the EntryGroup with the same name, this ID will be
4068
+ # different.
4075
4069
  # Corresponds to the JSON property `uid`
4076
4070
  # @return [String]
4077
4071
  attr_accessor :uid
@@ -4093,13 +4087,12 @@ module Google
4093
4087
  @etag = args[:etag] if args.key?(:etag)
4094
4088
  @labels = args[:labels] if args.key?(:labels)
4095
4089
  @name = args[:name] if args.key?(:name)
4096
- @transfer_status = args[:transfer_status] if args.key?(:transfer_status)
4097
4090
  @uid = args[:uid] if args.key?(:uid)
4098
4091
  @update_time = args[:update_time] if args.key?(:update_time)
4099
4092
  end
4100
4093
  end
4101
4094
 
4102
- # EntrySource contains source system related information for the entry.
4095
+ # EntrySource contains information related to the source system of the Entry.
4103
4096
  class GoogleCloudDataplexV1EntrySource
4104
4097
  include Google::Apis::Core::Hashable
4105
4098
 
@@ -4129,6 +4122,14 @@ module Google
4129
4122
  # @return [Hash<String,String>]
4130
4123
  attr_accessor :labels
4131
4124
 
4125
+ # Output only. Location of the resource in the source system. You can search the
4126
+ # Entry by this location. By default, this should match the location of the
4127
+ # EntryGroup containing this entry. A different value allows capturing the
4128
+ # source location for data external to Google Cloud.
4129
+ # Corresponds to the JSON property `location`
4130
+ # @return [String]
4131
+ attr_accessor :location
4132
+
4132
4133
  # The platform containing the source system. The maximum size of the field is 64
4133
4134
  # characters.
4134
4135
  # Corresponds to the JSON property `platform`
@@ -4162,6 +4163,7 @@ module Google
4162
4163
  @description = args[:description] if args.key?(:description)
4163
4164
  @display_name = args[:display_name] if args.key?(:display_name)
4164
4165
  @labels = args[:labels] if args.key?(:labels)
4166
+ @location = args[:location] if args.key?(:location)
4165
4167
  @platform = args[:platform] if args.key?(:platform)
4166
4168
  @resource = args[:resource] if args.key?(:resource)
4167
4169
  @system = args[:system] if args.key?(:system)
@@ -4219,9 +4221,9 @@ module Google
4219
4221
  # @return [String]
4220
4222
  attr_accessor :display_name
4221
4223
 
4222
- # Optional. This checksum is computed by the server based on the value of other
4223
- # fields, and may be sent on update and delete requests to ensure the client has
4224
- # an up-to-date value before proceeding.
4224
+ # Optional. This checksum is computed by the service, and might be sent on
4225
+ # update and delete requests to ensure the client has an up-to-date value before
4226
+ # proceeding.
4225
4227
  # Corresponds to the JSON property `etag`
4226
4228
  # @return [String]
4227
4229
  attr_accessor :etag
@@ -4253,7 +4255,7 @@ module Google
4253
4255
  # @return [String]
4254
4256
  attr_accessor :system
4255
4257
 
4256
- # Optional. Indicates the class this Entry Type belongs to, for example, TABLE,
4258
+ # Optional. Indicates the classes this Entry Type belongs to, for example, TABLE,
4257
4259
  # DATABASE, MODEL.
4258
4260
  # Corresponds to the JSON property `typeAliases`
4259
4261
  # @return [Array<String>]
@@ -4600,7 +4602,7 @@ module Google
4600
4602
  end
4601
4603
  end
4602
4604
 
4603
- # Generate recommended DataQualityRules request.
4605
+ # Request details for generating data quality rule recommendations.
4604
4606
  class GoogleCloudDataplexV1GenerateDataQualityRulesRequest
4605
4607
  include Google::Apis::Core::Hashable
4606
4608
 
@@ -4613,11 +4615,12 @@ module Google
4613
4615
  end
4614
4616
  end
4615
4617
 
4616
- # Generate recommended DataQualityRules response.
4618
+ # Response details for data quality rule recommendations.
4617
4619
  class GoogleCloudDataplexV1GenerateDataQualityRulesResponse
4618
4620
  include Google::Apis::Core::Hashable
4619
4621
 
4620
- # Generated recommended `@link DataQualityRule`s.
4622
+ # The data quality rules that Dataplex generates based on the results of a data
4623
+ # profiling scan.
4621
4624
  # Corresponds to the JSON property `rule`
4622
4625
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualityRule>]
4623
4626
  attr_accessor :rule
@@ -5031,11 +5034,11 @@ module Google
5031
5034
  end
5032
5035
  end
5033
5036
 
5034
- # List AspectTypes response
5037
+ # List AspectTypes response.
5035
5038
  class GoogleCloudDataplexV1ListAspectTypesResponse
5036
5039
  include Google::Apis::Core::Hashable
5037
5040
 
5038
- # ListAspectTypes under the given parent location.
5041
+ # AspectTypes under the given parent location.
5039
5042
  # Corresponds to the JSON property `aspectTypes`
5040
5043
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectType>]
5041
5044
  attr_accessor :aspect_types
@@ -5046,7 +5049,7 @@ module Google
5046
5049
  # @return [String]
5047
5050
  attr_accessor :next_page_token
5048
5051
 
5049
- # Locations that could not be reached.
5052
+ # Locations that the service couldn't reach.
5050
5053
  # Corresponds to the JSON property `unreachableLocations`
5051
5054
  # @return [Array<String>]
5052
5055
  attr_accessor :unreachable_locations
@@ -5295,16 +5298,17 @@ module Google
5295
5298
  end
5296
5299
  end
5297
5300
 
5298
- #
5301
+ # List Entries response.
5299
5302
  class GoogleCloudDataplexV1ListEntriesResponse
5300
5303
  include Google::Apis::Core::Hashable
5301
5304
 
5302
- # The list of entries.
5305
+ # The list of entries under the given parent location.
5303
5306
  # Corresponds to the JSON property `entries`
5304
5307
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry>]
5305
5308
  attr_accessor :entries
5306
5309
 
5307
- # Pagination token.
5310
+ # Token to retrieve the next page of results, or empty if there are no more
5311
+ # results in the list.
5308
5312
  # Corresponds to the JSON property `nextPageToken`
5309
5313
  # @return [String]
5310
5314
  attr_accessor :next_page_token
@@ -5320,11 +5324,11 @@ module Google
5320
5324
  end
5321
5325
  end
5322
5326
 
5323
- # List ListEntryGroups response.
5327
+ # List entry groups response.
5324
5328
  class GoogleCloudDataplexV1ListEntryGroupsResponse
5325
5329
  include Google::Apis::Core::Hashable
5326
5330
 
5327
- # ListEntryGroups under the given parent location.
5331
+ # Entry groups under the given parent location.
5328
5332
  # Corresponds to the JSON property `entryGroups`
5329
5333
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryGroup>]
5330
5334
  attr_accessor :entry_groups
@@ -5335,7 +5339,7 @@ module Google
5335
5339
  # @return [String]
5336
5340
  attr_accessor :next_page_token
5337
5341
 
5338
- # Locations that could not be reached.
5342
+ # Locations that the service couldn't reach.
5339
5343
  # Corresponds to the JSON property `unreachableLocations`
5340
5344
  # @return [Array<String>]
5341
5345
  attr_accessor :unreachable_locations
@@ -5352,11 +5356,11 @@ module Google
5352
5356
  end
5353
5357
  end
5354
5358
 
5355
- # List EntryTypes response
5359
+ # List EntryTypes response.
5356
5360
  class GoogleCloudDataplexV1ListEntryTypesResponse
5357
5361
  include Google::Apis::Core::Hashable
5358
5362
 
5359
- # ListEntryTypes under the given parent location.
5363
+ # EntryTypes under the given parent location.
5360
5364
  # Corresponds to the JSON property `entryTypes`
5361
5365
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryType>]
5362
5366
  attr_accessor :entry_types
@@ -5367,7 +5371,7 @@ module Google
5367
5371
  # @return [String]
5368
5372
  attr_accessor :next_page_token
5369
5373
 
5370
- # Locations that could not be reached.
5374
+ # Locations that the service couldn't reach.
5371
5375
  # Corresponds to the JSON property `unreachableLocations`
5372
5376
  # @return [Array<String>]
5373
5377
  attr_accessor :unreachable_locations
@@ -5980,7 +5984,8 @@ module Google
5980
5984
  class GoogleCloudDataplexV1SearchEntriesResponse
5981
5985
  include Google::Apis::Core::Hashable
5982
5986
 
5983
- # Pagination token.
5987
+ # Token to retrieve the next page of results, or empty if there are no more
5988
+ # results in the list.
5984
5989
  # Corresponds to the JSON property `nextPageToken`
5985
5990
  # @return [String]
5986
5991
  attr_accessor :next_page_token
@@ -5990,12 +5995,14 @@ module Google
5990
5995
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1SearchEntriesResult>]
5991
5996
  attr_accessor :results
5992
5997
 
5993
- # The estimated total number of matching entries. Not guaranteed to be accurate.
5998
+ # The estimated total number of matching entries. This number isn't guaranteed
5999
+ # to be accurate.
5994
6000
  # Corresponds to the JSON property `totalSize`
5995
6001
  # @return [Fixnum]
5996
6002
  attr_accessor :total_size
5997
6003
 
5998
- # Unreachable locations. Search results don't include data from those locations.
6004
+ # Locations that the service couldn't reach. Search results don't include data
6005
+ # from these locations.
5999
6006
  # Corresponds to the JSON property `unreachable`
6000
6007
  # @return [Array<String>]
6001
6008
  attr_accessor :unreachable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DataplexV1
18
18
  # Version of the google-apis-dataplex_v1 gem
19
- GEM_VERSION = "0.57.0"
19
+ GEM_VERSION = "0.59.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.15.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240523"
25
+ REVISION = "20240624"
26
26
  end
27
27
  end
28
28
  end
@@ -1320,7 +1320,6 @@ module Google
1320
1320
  property :metadata_template, as: 'metadataTemplate', class: Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate, decorator: Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate::Representation
1321
1321
 
1322
1322
  property :name, as: 'name'
1323
- property :transfer_status, as: 'transferStatus'
1324
1323
  property :uid, as: 'uid'
1325
1324
  property :update_time, as: 'updateTime'
1326
1325
  end
@@ -2112,6 +2111,7 @@ module Google
2112
2111
  class GoogleCloudDataplexV1DataScanExecutionStatus
2113
2112
  # @private
2114
2113
  class Representation < Google::Apis::Core::JsonRepresentation
2114
+ property :latest_job_create_time, as: 'latestJobCreateTime'
2115
2115
  property :latest_job_end_time, as: 'latestJobEndTime'
2116
2116
  property :latest_job_start_time, as: 'latestJobStartTime'
2117
2117
  end
@@ -2120,6 +2120,7 @@ module Google
2120
2120
  class GoogleCloudDataplexV1DataScanJob
2121
2121
  # @private
2122
2122
  class Representation < Google::Apis::Core::JsonRepresentation
2123
+ property :create_time, as: 'createTime'
2123
2124
  property :data_profile_result, as: 'dataProfileResult', class: Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResult, decorator: Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResult::Representation
2124
2125
 
2125
2126
  property :data_profile_spec, as: 'dataProfileSpec', class: Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileSpec, decorator: Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileSpec::Representation
@@ -2285,7 +2286,6 @@ module Google
2285
2286
  property :etag, as: 'etag'
2286
2287
  hash :labels, as: 'labels'
2287
2288
  property :name, as: 'name'
2288
- property :transfer_status, as: 'transferStatus'
2289
2289
  property :uid, as: 'uid'
2290
2290
  property :update_time, as: 'updateTime'
2291
2291
  end
@@ -2300,6 +2300,7 @@ module Google
2300
2300
  property :description, as: 'description'
2301
2301
  property :display_name, as: 'displayName'
2302
2302
  hash :labels, as: 'labels'
2303
+ property :location, as: 'location'
2303
2304
  property :platform, as: 'platform'
2304
2305
  property :resource, as: 'resource'
2305
2306
  property :system, as: 'system'
@@ -124,21 +124,21 @@ module Google
124
124
  execute_or_queue_command(command, &block)
125
125
  end
126
126
 
127
- # Looks up a single entry.
127
+ # Looks up a single Entry by name using the permission on the source system.
128
128
  # @param [String] name
129
129
  # Required. The project to which the request should be attributed in the
130
130
  # following form: projects/`project`/locations/`location`.
131
131
  # @param [Array<String>, String] aspect_types
132
- # Optional. Limits the aspects returned to the provided aspect types. Only works
133
- # if the CUSTOM view is selected.
132
+ # Optional. Limits the aspects returned to the provided aspect types. It only
133
+ # works for CUSTOM view.
134
134
  # @param [String] entry
135
135
  # Required. The resource name of the Entry: projects/`project`/locations/`
136
136
  # location`/entryGroups/`entry_group`/entries/`entry`.
137
137
  # @param [Array<String>, String] paths
138
138
  # Optional. Limits the aspects returned to those associated with the provided
139
- # paths within the Entry. Only works if the CUSTOM view is selected.
139
+ # paths within the Entry. It only works for CUSTOM view.
140
140
  # @param [String] view
141
- # Optional. View for controlling which parts of an entry are to be returned.
141
+ # Optional. View to control which parts of an entry the service should return.
142
142
  # @param [String] fields
143
143
  # Selector specifying which fields to include in a partial response.
144
144
  # @param [String] quota_user
@@ -170,20 +170,24 @@ module Google
170
170
  execute_or_queue_command(command, &block)
171
171
  end
172
172
 
173
- # Searches for entries matching given query and scope.
173
+ # Searches for Entries matching the given query and scope.
174
174
  # @param [String] name
175
175
  # Required. The project to which the request should be attributed in the
176
176
  # following form: projects/`project`/locations/`location`.
177
177
  # @param [String] order_by
178
- # Optional. Ordering of the results. Supported options to be added later.
178
+ # Optional. Specifies the ordering of results.
179
179
  # @param [Fixnum] page_size
180
- # Optional. Pagination.
180
+ # Optional. Number of results in the search page. If <=0, then defaults to 10.
181
+ # Max limit for page_size is 1000. Throws an invalid argument for page_size >
182
+ # 1000.
181
183
  # @param [String] page_token
184
+ # Optional. Page token received from a previous SearchEntries call. Provide this
185
+ # to retrieve the subsequent page.
182
186
  # @param [String] query
183
187
  # Required. The query against which entries in scope should be matched.
184
188
  # @param [String] scope
185
- # Optional. The scope under which the search should be operating. Should either
186
- # be organizations/ or projects/. If left unspecified, it will default to the
189
+ # Optional. The scope under which the search should be operating. It must either
190
+ # be organizations/ or projects/. If it is unspecified, it defaults to the
187
191
  # organization where the project provided in name is located.
188
192
  # @param [String] fields
189
193
  # Selector specifying which fields to include in a partial response.
@@ -217,17 +221,17 @@ module Google
217
221
  execute_or_queue_command(command, &block)
218
222
  end
219
223
 
220
- # Creates an AspectType
224
+ # Creates an AspectType.
221
225
  # @param [String] parent
222
226
  # Required. The resource name of the AspectType, of the form: projects/`
223
- # project_number`/locations/`location_id` where location_id refers to a GCP
224
- # region.
227
+ # project_number`/locations/`location_id` where location_id refers to a Google
228
+ # Cloud region.
225
229
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectType] google_cloud_dataplex_v1_aspect_type_object
226
230
  # @param [String] aspect_type_id
227
231
  # Required. AspectType identifier.
228
232
  # @param [Boolean] validate_only
229
- # Optional. Only validate the request, but do not perform mutations. The default
230
- # is false.
233
+ # Optional. The service validates the request without performing any mutations.
234
+ # The default is false.
231
235
  # @param [String] fields
232
236
  # Selector specifying which fields to include in a partial response.
233
237
  # @param [String] quota_user
@@ -259,13 +263,13 @@ module Google
259
263
  execute_or_queue_command(command, &block)
260
264
  end
261
265
 
262
- # Deletes a AspectType resource.
266
+ # Deletes an AspectType.
263
267
  # @param [String] name
264
268
  # Required. The resource name of the AspectType: projects/`project_number`/
265
269
  # locations/`location_id`/aspectTypes/`aspect_type_id`.
266
270
  # @param [String] etag
267
271
  # Optional. If the client provided etag value does not match the current etag
268
- # value, the DeleteAspectTypeRequest method returns an ABORTED error response
272
+ # value, the DeleteAspectTypeRequest method returns an ABORTED error response.
269
273
  # @param [String] fields
270
274
  # Selector specifying which fields to include in a partial response.
271
275
  # @param [String] quota_user
@@ -294,7 +298,7 @@ module Google
294
298
  execute_or_queue_command(command, &block)
295
299
  end
296
300
 
297
- # Retrieves a AspectType resource.
301
+ # Gets an AspectType.
298
302
  # @param [String] name
299
303
  # Required. The resource name of the AspectType: projects/`project_number`/
300
304
  # locations/`location_id`/aspectTypes/`aspect_type_id`.
@@ -373,23 +377,25 @@ module Google
373
377
  # Lists AspectType resources in a project and location.
374
378
  # @param [String] parent
375
379
  # Required. The resource name of the AspectType location, of the form: projects/`
376
- # project_number`/locations/`location_id` where location_id refers to a GCP
377
- # region.
380
+ # project_number`/locations/`location_id` where location_id refers to a Google
381
+ # Cloud region.
378
382
  # @param [String] filter
379
- # Optional. Filter request. Filters are case-sensitive. The following formats
380
- # are supported:labels.key1 = "value1" labels:key1 name = "value" These
381
- # restrictions can be coinjoined with AND, OR and NOT conjunctions.
383
+ # Optional. Filter request. Filters are case-sensitive. The service supports the
384
+ # following formats: labels.key1 = "value1" labels:key1 name = "value"These
385
+ # restrictions can be conjoined with AND, OR, and NOT conjunctions.
382
386
  # @param [String] order_by
383
- # Optional. Order by fields (name or create_time) for the result. If not
384
- # specified, the ordering is undefined.
387
+ # Optional. Orders the result by name or create_time fields. If not specified,
388
+ # the ordering is undefined.
385
389
  # @param [Fixnum] page_size
386
390
  # Optional. Maximum number of AspectTypes to return. The service may return
387
- # fewer than this value. If unspecified, at most 10 AspectTypes will be returned.
388
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
391
+ # fewer than this value. If unspecified, the service returns at most 10
392
+ # AspectTypes. The maximum value is 1000; values above 1000 will be coerced to
393
+ # 1000.
389
394
  # @param [String] page_token
390
395
  # Optional. Page token received from a previous ListAspectTypes call. Provide
391
396
  # this to retrieve the subsequent page. When paginating, all other parameters
392
- # provided to ListAspectTypes must match the call that provided the page token.
397
+ # you provide to ListAspectTypes must match the call that provided the page
398
+ # token.
393
399
  # @param [String] fields
394
400
  # Selector specifying which fields to include in a partial response.
395
401
  # @param [String] quota_user
@@ -421,7 +427,7 @@ module Google
421
427
  execute_or_queue_command(command, &block)
422
428
  end
423
429
 
424
- # Updates a AspectType resource.
430
+ # Updates an AspectType.
425
431
  # @param [String] name
426
432
  # Output only. The relative resource name of the AspectType, of the form:
427
433
  # projects/`project_number`/locations/`location_id`/aspectTypes/`aspect_type_id`.
@@ -944,11 +950,13 @@ module Google
944
950
  execute_or_queue_command(command, &block)
945
951
  end
946
952
 
947
- # Generates recommended DataQualityRule from a data profiling DataScan.
953
+ # Generates recommended data quality rules based on the results of a data
954
+ # profiling scan.Use the recommendations to build rules for a data quality scan.
948
955
  # @param [String] name
949
- # Required. The name should be either * the name of a datascan with at least one
950
- # successful completed data profiling job, or * the name of a successful
951
- # completed data profiling datascan job.
956
+ # Required. The name must be one of the following: The name of a data scan with
957
+ # at least one successful, completed data profiling job The name of a successful,
958
+ # completed data profiling job (a data scan job where the job type is data
959
+ # profiling)
952
960
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1GenerateDataQualityRulesRequest] google_cloud_dataplex_v1_generate_data_quality_rules_request_object
953
961
  # @param [String] fields
954
962
  # Selector specifying which fields to include in a partial response.
@@ -1262,11 +1270,13 @@ module Google
1262
1270
  execute_or_queue_command(command, &block)
1263
1271
  end
1264
1272
 
1265
- # Generates recommended DataQualityRule from a data profiling DataScan.
1273
+ # Generates recommended data quality rules based on the results of a data
1274
+ # profiling scan.Use the recommendations to build rules for a data quality scan.
1266
1275
  # @param [String] name
1267
- # Required. The name should be either * the name of a datascan with at least one
1268
- # successful completed data profiling job, or * the name of a successful
1269
- # completed data profiling datascan job.
1276
+ # Required. The name must be one of the following: The name of a data scan with
1277
+ # at least one successful, completed data profiling job The name of a successful,
1278
+ # completed data profiling job (a data scan job where the job type is data
1279
+ # profiling)
1270
1280
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1GenerateDataQualityRulesRequest] google_cloud_dataplex_v1_generate_data_quality_rules_request_object
1271
1281
  # @param [String] fields
1272
1282
  # Selector specifying which fields to include in a partial response.
@@ -2031,7 +2041,7 @@ module Google
2031
2041
  execute_or_queue_command(command, &block)
2032
2042
  end
2033
2043
 
2034
- # Creates an EntryGroup
2044
+ # Creates an EntryGroup.
2035
2045
  # @param [String] parent
2036
2046
  # Required. The resource name of the entryGroup, of the form: projects/`
2037
2047
  # project_number`/locations/`location_id` where location_id refers to a GCP
@@ -2040,8 +2050,8 @@ module Google
2040
2050
  # @param [String] entry_group_id
2041
2051
  # Required. EntryGroup identifier.
2042
2052
  # @param [Boolean] validate_only
2043
- # Optional. Only validate the request, but do not perform mutations. The default
2044
- # is false.
2053
+ # Optional. The service validates the request without performing any mutations.
2054
+ # The default is false.
2045
2055
  # @param [String] fields
2046
2056
  # Selector specifying which fields to include in a partial response.
2047
2057
  # @param [String] quota_user
@@ -2073,13 +2083,13 @@ module Google
2073
2083
  execute_or_queue_command(command, &block)
2074
2084
  end
2075
2085
 
2076
- # Deletes a EntryGroup resource.
2086
+ # Deletes an EntryGroup.
2077
2087
  # @param [String] name
2078
2088
  # Required. The resource name of the EntryGroup: projects/`project_number`/
2079
2089
  # locations/`location_id`/entryGroups/`entry_group_id`.
2080
2090
  # @param [String] etag
2081
2091
  # Optional. If the client provided etag value does not match the current etag
2082
- # value, the DeleteEntryGroupRequest method returns an ABORTED error response
2092
+ # value, the DeleteEntryGroupRequest method returns an ABORTED error response.
2083
2093
  # @param [String] fields
2084
2094
  # Selector specifying which fields to include in a partial response.
2085
2095
  # @param [String] quota_user
@@ -2108,7 +2118,7 @@ module Google
2108
2118
  execute_or_queue_command(command, &block)
2109
2119
  end
2110
2120
 
2111
- # Retrieves a EntryGroup resource.
2121
+ # Gets an EntryGroup.
2112
2122
  # @param [String] name
2113
2123
  # Required. The resource name of the EntryGroup: projects/`project_number`/
2114
2124
  # locations/`location_id`/entryGroups/`entry_group_id`.
@@ -2187,20 +2197,22 @@ module Google
2187
2197
  # Lists EntryGroup resources in a project and location.
2188
2198
  # @param [String] parent
2189
2199
  # Required. The resource name of the entryGroup location, of the form: projects/`
2190
- # project_number`/locations/`location_id` where location_id refers to a GCP
2191
- # region.
2200
+ # project_number`/locations/`location_id` where location_id refers to a Google
2201
+ # Cloud region.
2192
2202
  # @param [String] filter
2193
2203
  # Optional. Filter request.
2194
2204
  # @param [String] order_by
2195
2205
  # Optional. Order by fields for the result.
2196
2206
  # @param [Fixnum] page_size
2197
2207
  # Optional. Maximum number of EntryGroups to return. The service may return
2198
- # fewer than this value. If unspecified, at most 10 EntryGroups will be returned.
2199
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
2208
+ # fewer than this value. If unspecified, the service returns at most 10
2209
+ # EntryGroups. The maximum value is 1000; values above 1000 will be coerced to
2210
+ # 1000.
2200
2211
  # @param [String] page_token
2201
2212
  # Optional. Page token received from a previous ListEntryGroups call. Provide
2202
2213
  # this to retrieve the subsequent page. When paginating, all other parameters
2203
- # provided to ListEntryGroups must match the call that provided the page token.
2214
+ # you provide to ListEntryGroups must match the call that provided the page
2215
+ # token.
2204
2216
  # @param [String] fields
2205
2217
  # Selector specifying which fields to include in a partial response.
2206
2218
  # @param [String] quota_user
@@ -2232,7 +2244,7 @@ module Google
2232
2244
  execute_or_queue_command(command, &block)
2233
2245
  end
2234
2246
 
2235
- # Updates a EntryGroup resource.
2247
+ # Updates an EntryGroup.
2236
2248
  # @param [String] name
2237
2249
  # Output only. The relative resource name of the EntryGroup, of the form:
2238
2250
  # projects/`project_number`/locations/`location_id`/entryGroups/`entry_group_id`.
@@ -2240,8 +2252,8 @@ module Google
2240
2252
  # @param [String] update_mask
2241
2253
  # Required. Mask of fields to update.
2242
2254
  # @param [Boolean] validate_only
2243
- # Optional. Only validate the request, but do not perform mutations. The default
2244
- # is false.
2255
+ # Optional. The service validates the request, without performing any mutations.
2256
+ # The default is false.
2245
2257
  # @param [String] fields
2246
2258
  # Selector specifying which fields to include in a partial response.
2247
2259
  # @param [String] quota_user
@@ -2356,17 +2368,17 @@ module Google
2356
2368
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry] google_cloud_dataplex_v1_entry_object
2357
2369
  # @param [String] entry_id
2358
2370
  # Required. Entry identifier. It has to be unique within an Entry Group.Entries
2359
- # corresponding to Google Cloud resources use Entry ID format based on Full
2360
- # Resource Names (https://cloud.google.com/apis/design/resource_names#
2361
- # full_resource_name). The format is a Full Resource Name of the resource
2362
- # without the prefix double slashes in the API Service Name part of Full
2363
- # Resource Name. This allows retrieval of entries using their associated
2364
- # resource name.For example if the Full Resource Name of a resource is //library.
2365
- # googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is
2366
- # library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to
2367
- # follow the same convention for entries corresponding to resources from other
2368
- # providers or systems than Google Cloud.The maximum size of the field is 4000
2369
- # characters.
2371
+ # corresponding to Google Cloud resources use an Entry ID format based on full
2372
+ # resource names (https://cloud.google.com/apis/design/resource_names#
2373
+ # full_resource_name). The format is a full resource name of the resource
2374
+ # without the prefix double slashes in the API service name part of the full
2375
+ # resource name. This allows retrieval of entries using their associated
2376
+ # resource name.For example, if the full resource name of a resource is //
2377
+ # library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id
2378
+ # is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to
2379
+ # follow the same convention for entries corresponding to resources from
2380
+ # providers or systems other than Google Cloud.The maximum size of the field is
2381
+ # 4000 characters.
2370
2382
  # @param [String] fields
2371
2383
  # Selector specifying which fields to include in a partial response.
2372
2384
  # @param [String] quota_user
@@ -2428,18 +2440,18 @@ module Google
2428
2440
  execute_or_queue_command(command, &block)
2429
2441
  end
2430
2442
 
2431
- # Gets a single entry.
2443
+ # Gets an Entry.
2432
2444
  # @param [String] name
2433
2445
  # Required. The resource name of the Entry: projects/`project`/locations/`
2434
2446
  # location`/entryGroups/`entry_group`/entries/`entry`.
2435
2447
  # @param [Array<String>, String] aspect_types
2436
- # Optional. Limits the aspects returned to the provided aspect types. Only works
2437
- # if the CUSTOM view is selected.
2448
+ # Optional. Limits the aspects returned to the provided aspect types. It only
2449
+ # works for CUSTOM view.
2438
2450
  # @param [Array<String>, String] paths
2439
2451
  # Optional. Limits the aspects returned to those associated with the provided
2440
- # paths within the Entry. Only works if the CUSTOM view is selected.
2452
+ # paths within the Entry. It only works for CUSTOM view.
2441
2453
  # @param [String] view
2442
- # Optional. View for controlling which parts of an entry are to be returned.
2454
+ # Optional. View to control which parts of an entry the service should return.
2443
2455
  # @param [String] fields
2444
2456
  # Selector specifying which fields to include in a partial response.
2445
2457
  # @param [String] quota_user
@@ -2470,24 +2482,29 @@ module Google
2470
2482
  execute_or_queue_command(command, &block)
2471
2483
  end
2472
2484
 
2473
- # Lists entries within an entry group.
2485
+ # Lists Entries within an EntryGroup.
2474
2486
  # @param [String] parent
2475
2487
  # Required. The resource name of the parent Entry Group: projects/`project`/
2476
2488
  # locations/`location`/entryGroups/`entry_group`.
2477
2489
  # @param [String] filter
2478
- # Optional. A filter on the entries to return. Filters are case-sensitive. The
2479
- # request can be filtered by the following fields: entry_type, entry_source.
2480
- # display_name. The comparison operators are =, !=, <, >, <=, >= (strings are
2481
- # compared according to lexical order) The logical operators AND, OR, NOT can be
2482
- # used in the filter. Wildcard "*" can be used, but for entry_type the full
2483
- # project id or number needs to be provided. Example filter expressions: "
2490
+ # Optional. A filter on the entries to return. Filters are case-sensitive. You
2491
+ # can filter the request by the following fields: entry_type entry_source.
2492
+ # display_nameThe comparison operators are =, !=, <, >, <=, >=. The service
2493
+ # compares strings according to lexical order.You can use the logical operators
2494
+ # AND, OR, NOT in the filter.You can use Wildcard "*", but for entry_type you
2495
+ # need to provide the full project id or number.Example filter expressions: "
2484
2496
  # entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-
2485
2497
  # project/locations/global/entryTypes/example-entry_type" "entry_type=projects/
2486
2498
  # example-project/locations/us/entryTypes/a* OR entry_type=projects/another-
2487
2499
  # project/locations/*" "NOT entry_source.display_name=AnotherExampleDisplayName"
2488
2500
  # @param [Fixnum] page_size
2501
+ # Optional. Number of items to return per page. If there are remaining results,
2502
+ # the service returns a next_page_token. If unspecified, the service returns at
2503
+ # most 10 Entries. The maximum value is 100; values above 100 will be coerced to
2504
+ # 100.
2489
2505
  # @param [String] page_token
2490
- # Optional. The pagination token returned by a previous request.
2506
+ # Optional. Page token received from a previous ListEntries call. Provide this
2507
+ # to retrieve the subsequent page.
2491
2508
  # @param [String] fields
2492
2509
  # Selector specifying which fields to include in a partial response.
2493
2510
  # @param [String] quota_user
@@ -2524,22 +2541,25 @@ module Google
2524
2541
  # project`/locations/`location`/entryGroups/`entry_group`/entries/`entry`.
2525
2542
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry] google_cloud_dataplex_v1_entry_object
2526
2543
  # @param [Boolean] allow_missing
2527
- # Optional. If set to true and the entry does not exist, it will be created.
2544
+ # Optional. If set to true and the entry doesn't exist, the service will create
2545
+ # it.
2528
2546
  # @param [Array<String>, String] aspect_keys
2529
- # Optional. The map keys of the Aspects which should be modified. Supports the
2530
- # following syntaxes: * - matches aspect on given type and empty path * @path -
2531
- # matches aspect on given type and specified path * * - matches aspects on given
2532
- # type for all paths * *@path - matches aspects of all types on the given
2533
- # pathExisting aspects matching the syntax will not be removed unless
2534
- # delete_missing_aspects is set to true.If this field is left empty, it will be
2535
- # treated as specifying exactly those Aspects present in the request.
2547
+ # Optional. The map keys of the Aspects which the service should modify. It
2548
+ # supports the following syntaxes: - matches an aspect of the given type and
2549
+ # empty path. @path - matches an aspect of the given type and specified path. * -
2550
+ # matches aspects of the given type for all paths. *@path - matches aspects of
2551
+ # all types on the given path.The service will not remove existing aspects
2552
+ # matching the syntax unless delete_missing_aspects is set to true.If this field
2553
+ # is left empty, the service treats it as specifying exactly those Aspects
2554
+ # present in the request.
2536
2555
  # @param [Boolean] delete_missing_aspects
2537
- # Optional. If set to true and the aspect_keys specify aspect ranges, any
2538
- # existing aspects from that range not provided in the request will be deleted.
2556
+ # Optional. If set to true and the aspect_keys specify aspect ranges, the
2557
+ # service deletes any existing aspects from that range that weren't provided in
2558
+ # the request.
2539
2559
  # @param [String] update_mask
2540
2560
  # Optional. Mask of fields to update. To update Aspects, the update_mask must
2541
- # contain the value "aspects".If the update_mask is empty, all modifiable fields
2542
- # present in the request will be updated.
2561
+ # contain the value "aspects".If the update_mask is empty, the service will
2562
+ # update all modifiable fields present in the request.
2543
2563
  # @param [String] fields
2544
2564
  # Selector specifying which fields to include in a partial response.
2545
2565
  # @param [String] quota_user
@@ -2573,17 +2593,17 @@ module Google
2573
2593
  execute_or_queue_command(command, &block)
2574
2594
  end
2575
2595
 
2576
- # Creates an EntryType
2596
+ # Creates an EntryType.
2577
2597
  # @param [String] parent
2578
2598
  # Required. The resource name of the EntryType, of the form: projects/`
2579
- # project_number`/locations/`location_id` where location_id refers to a GCP
2580
- # region.
2599
+ # project_number`/locations/`location_id` where location_id refers to a Google
2600
+ # Cloud region.
2581
2601
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryType] google_cloud_dataplex_v1_entry_type_object
2582
2602
  # @param [String] entry_type_id
2583
2603
  # Required. EntryType identifier.
2584
2604
  # @param [Boolean] validate_only
2585
- # Optional. Only validate the request, but do not perform mutations. The default
2586
- # is false.
2605
+ # Optional. The service validates the request without performing any mutations.
2606
+ # The default is false.
2587
2607
  # @param [String] fields
2588
2608
  # Selector specifying which fields to include in a partial response.
2589
2609
  # @param [String] quota_user
@@ -2615,13 +2635,13 @@ module Google
2615
2635
  execute_or_queue_command(command, &block)
2616
2636
  end
2617
2637
 
2618
- # Deletes a EntryType resource.
2638
+ # Deletes an EntryType.
2619
2639
  # @param [String] name
2620
2640
  # Required. The resource name of the EntryType: projects/`project_number`/
2621
2641
  # locations/`location_id`/entryTypes/`entry_type_id`.
2622
2642
  # @param [String] etag
2623
2643
  # Optional. If the client provided etag value does not match the current etag
2624
- # value, the DeleteEntryTypeRequest method returns an ABORTED error response
2644
+ # value, the DeleteEntryTypeRequest method returns an ABORTED error response.
2625
2645
  # @param [String] fields
2626
2646
  # Selector specifying which fields to include in a partial response.
2627
2647
  # @param [String] quota_user
@@ -2650,7 +2670,7 @@ module Google
2650
2670
  execute_or_queue_command(command, &block)
2651
2671
  end
2652
2672
 
2653
- # Retrieves a EntryType resource.
2673
+ # Gets an EntryType.
2654
2674
  # @param [String] name
2655
2675
  # Required. The resource name of the EntryType: projects/`project_number`/
2656
2676
  # locations/`location_id`/entryTypes/`entry_type_id`.
@@ -2729,23 +2749,24 @@ module Google
2729
2749
  # Lists EntryType resources in a project and location.
2730
2750
  # @param [String] parent
2731
2751
  # Required. The resource name of the EntryType location, of the form: projects/`
2732
- # project_number`/locations/`location_id` where location_id refers to a GCP
2733
- # region.
2752
+ # project_number`/locations/`location_id` where location_id refers to a Google
2753
+ # Cloud region.
2734
2754
  # @param [String] filter
2735
- # Optional. Filter request. Filters are case-sensitive. The following formats
2736
- # are supported:labels.key1 = "value1" labels:key1 name = "value" These
2737
- # restrictions can be coinjoined with AND, OR and NOT conjunctions.
2755
+ # Optional. Filter request. Filters are case-sensitive. The service supports the
2756
+ # following formats: labels.key1 = "value1" labels:key1 name = "value"These
2757
+ # restrictions can be conjoined with AND, OR, and NOT conjunctions.
2738
2758
  # @param [String] order_by
2739
- # Optional. Order by fields (name or create_time) for the result. If not
2740
- # specified, the ordering is undefined.
2759
+ # Optional. Orders the result by name or create_time fields. If not specified,
2760
+ # the ordering is undefined.
2741
2761
  # @param [Fixnum] page_size
2742
2762
  # Optional. Maximum number of EntryTypes to return. The service may return fewer
2743
- # than this value. If unspecified, at most 10 EntryTypes will be returned. The
2744
- # maximum value is 1000; values above 1000 will be coerced to 1000.
2763
+ # than this value. If unspecified, the service returns at most 10 EntryTypes.
2764
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
2745
2765
  # @param [String] page_token
2746
2766
  # Optional. Page token received from a previous ListEntryTypes call. Provide
2747
2767
  # this to retrieve the subsequent page. When paginating, all other parameters
2748
- # provided to ListEntryTypes must match the call that provided the page token.
2768
+ # you provided to ListEntryTypes must match the call that provided the page
2769
+ # token.
2749
2770
  # @param [String] fields
2750
2771
  # Selector specifying which fields to include in a partial response.
2751
2772
  # @param [String] quota_user
@@ -2777,7 +2798,7 @@ module Google
2777
2798
  execute_or_queue_command(command, &block)
2778
2799
  end
2779
2800
 
2780
- # Updates a EntryType resource.
2801
+ # Updates an EntryType.
2781
2802
  # @param [String] name
2782
2803
  # Output only. The relative resource name of the EntryType, of the form:
2783
2804
  # projects/`project_number`/locations/`location_id`/entryTypes/`entry_type_id`.
@@ -2785,8 +2806,8 @@ module Google
2785
2806
  # @param [String] update_mask
2786
2807
  # Required. Mask of fields to update.
2787
2808
  # @param [Boolean] validate_only
2788
- # Optional. Only validate the request, but do not perform mutations. The default
2789
- # is false.
2809
+ # Optional. The service validates the request without performing any mutations.
2810
+ # The default is false.
2790
2811
  # @param [String] fields
2791
2812
  # Selector specifying which fields to include in a partial response.
2792
2813
  # @param [String] quota_user
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-dataplex_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.57.0
4
+ version: 0.59.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-06-02 00:00:00.000000000 Z
11
+ date: 2024-07-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dataplex_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-dataplex_v1/v0.57.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-dataplex_v1/v0.59.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dataplex_v1
63
63
  post_install_message:
64
64
  rdoc_options: []