google-apis-dataplex_v1 0.58.0 → 0.60.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.
@@ -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
+ # 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,16 +383,16 @@ module Google
384
383
  end
385
384
  end
386
385
 
387
- # AspectSource contains source system related information for the aspect.
386
+ # Information related to the source system of the aspect.
388
387
  class GoogleCloudDataplexV1AspectSource
389
388
  include Google::Apis::Core::Hashable
390
389
 
391
- # The create time of the aspect in the source system.
390
+ # The time the aspect was created in the source system.
392
391
  # Corresponds to the JSON property `createTime`
393
392
  # @return [String]
394
393
  attr_accessor :create_time
395
394
 
396
- # The update time of the aspect in the source system.
395
+ # The time the aspect was last updated in the source system.
397
396
  # Corresponds to the JSON property `updateTime`
398
397
  # @return [String]
399
398
  attr_accessor :update_time
@@ -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]
@@ -1178,6 +1167,19 @@ module Google
1178
1167
  end
1179
1168
  end
1180
1169
 
1170
+ # Cancel metadata job request.
1171
+ class GoogleCloudDataplexV1CancelMetadataJobRequest
1172
+ include Google::Apis::Core::Hashable
1173
+
1174
+ def initialize(**args)
1175
+ update!(**args)
1176
+ end
1177
+
1178
+ # Update properties of this object
1179
+ def update!(**args)
1180
+ end
1181
+ end
1182
+
1181
1183
  # Content represents a user-visible notebook or a sql script
1182
1184
  class GoogleCloudDataplexV1Content
1183
1185
  include Google::Apis::Core::Hashable
@@ -1693,7 +1695,8 @@ module Google
1693
1695
  include Google::Apis::Core::Hashable
1694
1696
 
1695
1697
  # Ratio of rows with distinct values against total scanned rows. Not available
1696
- # for complex non-groupable field type RECORD and fields with REPEATABLE mode.
1698
+ # for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and
1699
+ # JSON, as well as fields with REPEATABLE mode.
1697
1700
  # Corresponds to the JSON property `distinctRatio`
1698
1701
  # @return [Float]
1699
1702
  attr_accessor :distinct_ratio
@@ -1721,7 +1724,8 @@ module Google
1721
1724
  # The list of top N non-null values, frequency and ratio with which they occur
1722
1725
  # in the scanned data. N is 10 or equal to the number of distinct values in the
1723
1726
  # field, whichever is smaller. Not available for complex non-groupable field
1724
- # type RECORD and fields with REPEATABLE mode.
1727
+ # type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with
1728
+ # REPEATABLE mode.
1725
1729
  # Corresponds to the JSON property `topNValues`
1726
1730
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue>]
1727
1731
  attr_accessor :top_n_values
@@ -2299,6 +2303,12 @@ module Google
2299
2303
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation]
2300
2304
  attr_accessor :statistic_range_expectation
2301
2305
 
2306
+ # Optional. Whether the Rule is active or suspended. Default is false.
2307
+ # Corresponds to the JSON property `suspended`
2308
+ # @return [Boolean]
2309
+ attr_accessor :suspended
2310
+ alias_method :suspended?, :suspended
2311
+
2302
2312
  # Evaluates whether the provided expression is true.The SQL expression needs to
2303
2313
  # use BigQuery standard SQL syntax and should produce a scalar boolean result.
2304
2314
  # Example: MIN(col1) >= 0
@@ -2336,6 +2346,7 @@ module Google
2336
2346
  @set_expectation = args[:set_expectation] if args.key?(:set_expectation)
2337
2347
  @sql_assertion = args[:sql_assertion] if args.key?(:sql_assertion)
2338
2348
  @statistic_range_expectation = args[:statistic_range_expectation] if args.key?(:statistic_range_expectation)
2349
+ @suspended = args[:suspended] if args.key?(:suspended)
2339
2350
  @table_condition_expectation = args[:table_condition_expectation] if args.key?(:table_condition_expectation)
2340
2351
  @threshold = args[:threshold] if args.key?(:threshold)
2341
2352
  @uniqueness_expectation = args[:uniqueness_expectation] if args.key?(:uniqueness_expectation)
@@ -3408,6 +3419,11 @@ module Google
3408
3419
  class GoogleCloudDataplexV1DataScanJob
3409
3420
  include Google::Apis::Core::Hashable
3410
3421
 
3422
+ # Output only. The time when the DataScanJob was created.
3423
+ # Corresponds to the JSON property `createTime`
3424
+ # @return [String]
3425
+ attr_accessor :create_time
3426
+
3411
3427
  # DataProfileResult defines the output of DataProfileScan. Each field of the
3412
3428
  # table will have field type specific profile result.
3413
3429
  # Corresponds to the JSON property `dataProfileResult`
@@ -3473,6 +3489,7 @@ module Google
3473
3489
 
3474
3490
  # Update properties of this object
3475
3491
  def update!(**args)
3492
+ @create_time = args[:create_time] if args.key?(:create_time)
3476
3493
  @data_profile_result = args[:data_profile_result] if args.key?(:data_profile_result)
3477
3494
  @data_profile_spec = args[:data_profile_spec] if args.key?(:data_profile_spec)
3478
3495
  @data_quality_result = args[:data_quality_result] if args.key?(:data_quality_result)
@@ -3964,43 +3981,48 @@ module Google
3964
3981
  end
3965
3982
  end
3966
3983
 
3967
- # An entry is a representation of a data asset which can be described by various
3968
- # metadata.
3984
+ # An entry is a representation of a data resource that can be described by
3985
+ # various metadata.
3969
3986
  class GoogleCloudDataplexV1Entry
3970
3987
  include Google::Apis::Core::Hashable
3971
3988
 
3972
- # Optional. The Aspects attached to the Entry. The format for the key can be one
3973
- # of the following: 1. `projectId`.`locationId`.`aspectTypeId` (if the aspect is
3974
- # attached directly to the entry) 2. `projectId`.`locationId`.`aspectTypeId`@`
3975
- # path` (if the aspect is attached to an entry's path)
3989
+ # Optional. The aspects that are attached to the entry. Depending on how the
3990
+ # aspect is attached to the entry, the format of the aspect key can be one of
3991
+ # the following: If the aspect is attached directly to the entry: `
3992
+ # project_id_or_number`.`location_id`.`aspect_type_id` If the aspect is attached
3993
+ # to an entry's path: `project_id_or_number`.`location_id`.`aspect_type_id`@`
3994
+ # path`
3976
3995
  # Corresponds to the JSON property `aspects`
3977
3996
  # @return [Hash<String,Google::Apis::DataplexV1::GoogleCloudDataplexV1Aspect>]
3978
3997
  attr_accessor :aspects
3979
3998
 
3980
- # Output only. The time when the Entry was created.
3999
+ # Output only. The time when the entry was created in Dataplex.
3981
4000
  # Corresponds to the JSON property `createTime`
3982
4001
  # @return [String]
3983
4002
  attr_accessor :create_time
3984
4003
 
3985
- # EntrySource contains source system related information for the entry.
4004
+ # Information related to the source system of the data resource that is
4005
+ # represented by the entry.
3986
4006
  # Corresponds to the JSON property `entrySource`
3987
4007
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntrySource]
3988
4008
  attr_accessor :entry_source
3989
4009
 
3990
- # Required. Immutable. The resource name of the EntryType used to create this
3991
- # Entry.
4010
+ # Required. Immutable. The relative resource name of the entry type that was
4011
+ # used to create this entry, in the format projects/`project_id_or_number`/
4012
+ # locations/`location_id`/entryTypes/`entry_type_id`.
3992
4013
  # Corresponds to the JSON property `entryType`
3993
4014
  # @return [String]
3994
4015
  attr_accessor :entry_type
3995
4016
 
3996
- # Optional. A name for the entry that can reference it in an external system.
4017
+ # Optional. A name for the entry that can be referenced by an external system.
3997
4018
  # The maximum size of the field is 4000 characters.
3998
4019
  # Corresponds to the JSON property `fullyQualifiedName`
3999
4020
  # @return [String]
4000
4021
  attr_accessor :fully_qualified_name
4001
4022
 
4002
- # Identifier. The relative resource name of the Entry, of the form: projects/`
4003
- # project`/locations/`location`/entryGroups/`entry_group`/entries/`entry`.
4023
+ # Identifier. The relative resource name of the entry, in the format projects/`
4024
+ # project_id_or_number`/locations/`location_id`/entryGroups/`entry_group_id`/
4025
+ # entries/`entry_id`.
4004
4026
  # Corresponds to the JSON property `name`
4005
4027
  # @return [String]
4006
4028
  attr_accessor :name
@@ -4010,7 +4032,7 @@ module Google
4010
4032
  # @return [String]
4011
4033
  attr_accessor :parent_entry
4012
4034
 
4013
- # Output only. The time when the Entry was last updated.
4035
+ # Output only. The time when the entry was last updated in Dataplex.
4014
4036
  # Corresponds to the JSON property `updateTime`
4015
4037
  # @return [String]
4016
4038
  attr_accessor :update_time
@@ -4051,9 +4073,8 @@ module Google
4051
4073
  # @return [String]
4052
4074
  attr_accessor :display_name
4053
4075
 
4054
- # This checksum is computed by the server based on the value of other fields,
4055
- # and may be sent on update and delete requests to ensure the client has an up-
4056
- # to-date value before proceeding.
4076
+ # This checksum is computed by the service, and might be sent on update and
4077
+ # delete requests to ensure the client has an up-to-date value before proceeding.
4057
4078
  # Corresponds to the JSON property `etag`
4058
4079
  # @return [String]
4059
4080
  attr_accessor :etag
@@ -4063,21 +4084,16 @@ module Google
4063
4084
  # @return [Hash<String,String>]
4064
4085
  attr_accessor :labels
4065
4086
 
4066
- # Output only. The relative resource name of the EntryGroup, of the form:
4067
- # projects/`project_number`/locations/`location_id`/entryGroups/`entry_group_id`.
4087
+ # Output only. The relative resource name of the EntryGroup, in the format
4088
+ # projects/`project_id_or_number`/locations/`location_id`/entryGroups/`
4089
+ # entry_group_id`.
4068
4090
  # Corresponds to the JSON property `name`
4069
4091
  # @return [String]
4070
4092
  attr_accessor :name
4071
4093
 
4072
- # Output only. Denotes the transfer status of the Entry Group. It is unspecified
4073
- # for Entry Group created from Dataplex API.
4074
- # Corresponds to the JSON property `transferStatus`
4075
- # @return [String]
4076
- attr_accessor :transfer_status
4077
-
4078
- # Output only. System generated globally unique ID for the EntryGroup. This ID
4079
- # will be different if the EntryGroup is deleted and re-created with the same
4080
- # name.
4094
+ # Output only. System generated globally unique ID for the EntryGroup. If you
4095
+ # delete and recreate the EntryGroup with the same name, this ID will be
4096
+ # different.
4081
4097
  # Corresponds to the JSON property `uid`
4082
4098
  # @return [String]
4083
4099
  attr_accessor :uid
@@ -4099,32 +4115,33 @@ module Google
4099
4115
  @etag = args[:etag] if args.key?(:etag)
4100
4116
  @labels = args[:labels] if args.key?(:labels)
4101
4117
  @name = args[:name] if args.key?(:name)
4102
- @transfer_status = args[:transfer_status] if args.key?(:transfer_status)
4103
4118
  @uid = args[:uid] if args.key?(:uid)
4104
4119
  @update_time = args[:update_time] if args.key?(:update_time)
4105
4120
  end
4106
4121
  end
4107
4122
 
4108
- # EntrySource contains source system related information for the entry.
4123
+ # Information related to the source system of the data resource that is
4124
+ # represented by the entry.
4109
4125
  class GoogleCloudDataplexV1EntrySource
4110
4126
  include Google::Apis::Core::Hashable
4111
4127
 
4112
- # Immutable. The ancestors of the Entry in the source system.
4128
+ # Immutable. The entries representing the ancestors of the data resource in the
4129
+ # source system.
4113
4130
  # Corresponds to the JSON property `ancestors`
4114
4131
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EntrySourceAncestor>]
4115
4132
  attr_accessor :ancestors
4116
4133
 
4117
- # The create time of the resource in the source system.
4134
+ # The time when the resource was created in the source system.
4118
4135
  # Corresponds to the JSON property `createTime`
4119
4136
  # @return [String]
4120
4137
  attr_accessor :create_time
4121
4138
 
4122
- # Description of the Entry. The maximum size of the field is 2000 characters.
4139
+ # A description of the data resource. Maximum length is 2,000 characters.
4123
4140
  # Corresponds to the JSON property `description`
4124
4141
  # @return [String]
4125
4142
  attr_accessor :description
4126
4143
 
4127
- # User friendly display name. The maximum size of the field is 500 characters.
4144
+ # A user-friendly display name. Maximum length is 500 characters.
4128
4145
  # Corresponds to the JSON property `displayName`
4129
4146
  # @return [String]
4130
4147
  attr_accessor :display_name
@@ -4135,32 +4152,34 @@ module Google
4135
4152
  # @return [Hash<String,String>]
4136
4153
  attr_accessor :labels
4137
4154
 
4138
- # Output only. Location of the resource in the source system. Entry will be
4139
- # searchable by this location. By default, this should match the location of the
4140
- # EntryGroup containing this entry. A different value allows capturing source
4141
- # location for data external to GCP.
4155
+ # Output only. Location of the resource in the source system. You can search the
4156
+ # entry by this location. By default, this should match the location of the
4157
+ # entry group containing this entry. A different value allows capturing the
4158
+ # source location for data external to Google Cloud.
4142
4159
  # Corresponds to the JSON property `location`
4143
4160
  # @return [String]
4144
4161
  attr_accessor :location
4145
4162
 
4146
- # The platform containing the source system. The maximum size of the field is 64
4147
- # characters.
4163
+ # The platform containing the source system. Maximum length is 64 characters.
4148
4164
  # Corresponds to the JSON property `platform`
4149
4165
  # @return [String]
4150
4166
  attr_accessor :platform
4151
4167
 
4152
- # The name of the resource in the source system. The maximum size of the field
4153
- # is 4000 characters.
4168
+ # The name of the resource in the source system. Maximum length is 4,000
4169
+ # characters.
4154
4170
  # Corresponds to the JSON property `resource`
4155
4171
  # @return [String]
4156
4172
  attr_accessor :resource
4157
4173
 
4158
- # The name of the source system. The maximum size of the field is 64 characters.
4174
+ # The name of the source system. Maximum length is 64 characters.
4159
4175
  # Corresponds to the JSON property `system`
4160
4176
  # @return [String]
4161
4177
  attr_accessor :system
4162
4178
 
4163
- # The update time of the resource in the source system.
4179
+ # The time when the resource was last updated in the source system. If the entry
4180
+ # exists in the system and its EntrySource has update_time populated, further
4181
+ # updates to the EntrySource of the entry must provide incremental updates to
4182
+ # its update_time.
4164
4183
  # Corresponds to the JSON property `updateTime`
4165
4184
  # @return [String]
4166
4185
  attr_accessor :update_time
@@ -4184,8 +4203,8 @@ module Google
4184
4203
  end
4185
4204
  end
4186
4205
 
4187
- # Ancestor contains information about individual items in the hierarchy of an
4188
- # Entry.
4206
+ # Information about individual items in the hierarchy that is associated with
4207
+ # the data resource.
4189
4208
  class GoogleCloudDataplexV1EntrySourceAncestor
4190
4209
  include Google::Apis::Core::Hashable
4191
4210
 
@@ -4234,9 +4253,9 @@ module Google
4234
4253
  # @return [String]
4235
4254
  attr_accessor :display_name
4236
4255
 
4237
- # Optional. This checksum is computed by the server based on the value of other
4238
- # fields, and may be sent on update and delete requests to ensure the client has
4239
- # an up-to-date value before proceeding.
4256
+ # Optional. This checksum is computed by the service, and might be sent on
4257
+ # update and delete requests to ensure the client has an up-to-date value before
4258
+ # proceeding.
4240
4259
  # Corresponds to the JSON property `etag`
4241
4260
  # @return [String]
4242
4261
  attr_accessor :etag
@@ -4268,7 +4287,7 @@ module Google
4268
4287
  # @return [String]
4269
4288
  attr_accessor :system
4270
4289
 
4271
- # Optional. Indicates the class this Entry Type belongs to, for example, TABLE,
4290
+ # Optional. Indicates the classes this Entry Type belongs to, for example, TABLE,
4272
4291
  # DATABASE, MODEL.
4273
4292
  # Corresponds to the JSON property `typeAliases`
4274
4293
  # @return [Array<String>]
@@ -4706,6 +4725,63 @@ module Google
4706
4725
  end
4707
4726
  end
4708
4727
 
4728
+ # An object that describes the values that you want to set for an entry and its
4729
+ # attached aspects when you import metadata. Used when you run a metadata import
4730
+ # job. See CreateMetadataJob.You provide a collection of import items in a
4731
+ # metadata import file. For more information about how to create a metadata
4732
+ # import file, see Metadata import file (https://cloud.google.com/dataplex/docs/
4733
+ # import-metadata#metadata-import-file).
4734
+ class GoogleCloudDataplexV1ImportItem
4735
+ include Google::Apis::Core::Hashable
4736
+
4737
+ # The aspects to modify. Supports the following syntaxes: `aspect_type_reference`
4738
+ # : matches aspects that belong to the specified aspect type and are attached
4739
+ # directly to the entry. `aspect_type_reference`@`path`: matches aspects that
4740
+ # belong to the specified aspect type and path. `aspect_type_reference`@*:
4741
+ # matches aspects that belong to the specified aspect type for all paths.Replace
4742
+ # `aspect_type_reference` with a reference to the aspect type, in the format `
4743
+ # project_id_or_number`.`location_id`.`aspect_type_id`.If you leave this field
4744
+ # empty, it is treated as specifying exactly those aspects that are present
4745
+ # within the specified entry.In FULL entry sync mode, Dataplex implicitly adds
4746
+ # the keys for all of the required aspects of an entry.
4747
+ # Corresponds to the JSON property `aspectKeys`
4748
+ # @return [Array<String>]
4749
+ attr_accessor :aspect_keys
4750
+
4751
+ # An entry is a representation of a data resource that can be described by
4752
+ # various metadata.
4753
+ # Corresponds to the JSON property `entry`
4754
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry]
4755
+ attr_accessor :entry
4756
+
4757
+ # The fields to update, in paths that are relative to the Entry resource.
4758
+ # Separate each field with a comma.In FULL entry sync mode, Dataplex includes
4759
+ # the paths of all of the fields for an entry that can be modified, including
4760
+ # aspects. This means that Dataplex replaces the existing entry with the entry
4761
+ # in the metadata import file. All modifiable fields are updated, regardless of
4762
+ # the fields that are listed in the update mask, and regardless of whether a
4763
+ # field is present in the entry object.The update_mask field is ignored when an
4764
+ # entry is created or re-created.Dataplex also determines which entries and
4765
+ # aspects to modify by comparing the values and timestamps that you provide in
4766
+ # the metadata import file with the values and timestamps that exist in your
4767
+ # project. For more information, see Comparison logic (https://cloud.google.com/
4768
+ # dataplex/docs/import-metadata#data-modification-logic).
4769
+ # Corresponds to the JSON property `updateMask`
4770
+ # @return [String]
4771
+ attr_accessor :update_mask
4772
+
4773
+ def initialize(**args)
4774
+ update!(**args)
4775
+ end
4776
+
4777
+ # Update properties of this object
4778
+ def update!(**args)
4779
+ @aspect_keys = args[:aspect_keys] if args.key?(:aspect_keys)
4780
+ @entry = args[:entry] if args.key?(:entry)
4781
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
4782
+ end
4783
+ end
4784
+
4709
4785
  # A job represents an instance of a task.
4710
4786
  class GoogleCloudDataplexV1Job
4711
4787
  include Google::Apis::Core::Hashable
@@ -5047,11 +5123,11 @@ module Google
5047
5123
  end
5048
5124
  end
5049
5125
 
5050
- # List AspectTypes response
5126
+ # List AspectTypes response.
5051
5127
  class GoogleCloudDataplexV1ListAspectTypesResponse
5052
5128
  include Google::Apis::Core::Hashable
5053
5129
 
5054
- # ListAspectTypes under the given parent location.
5130
+ # AspectTypes under the given parent location.
5055
5131
  # Corresponds to the JSON property `aspectTypes`
5056
5132
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectType>]
5057
5133
  attr_accessor :aspect_types
@@ -5062,7 +5138,7 @@ module Google
5062
5138
  # @return [String]
5063
5139
  attr_accessor :next_page_token
5064
5140
 
5065
- # Locations that could not be reached.
5141
+ # Locations that the service couldn't reach.
5066
5142
  # Corresponds to the JSON property `unreachableLocations`
5067
5143
  # @return [Array<String>]
5068
5144
  attr_accessor :unreachable_locations
@@ -5311,16 +5387,17 @@ module Google
5311
5387
  end
5312
5388
  end
5313
5389
 
5314
- #
5390
+ # List Entries response.
5315
5391
  class GoogleCloudDataplexV1ListEntriesResponse
5316
5392
  include Google::Apis::Core::Hashable
5317
5393
 
5318
- # The list of entries.
5394
+ # The list of entries under the given parent location.
5319
5395
  # Corresponds to the JSON property `entries`
5320
5396
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry>]
5321
5397
  attr_accessor :entries
5322
5398
 
5323
- # Pagination token.
5399
+ # Token to retrieve the next page of results, or empty if there are no more
5400
+ # results in the list.
5324
5401
  # Corresponds to the JSON property `nextPageToken`
5325
5402
  # @return [String]
5326
5403
  attr_accessor :next_page_token
@@ -5336,11 +5413,11 @@ module Google
5336
5413
  end
5337
5414
  end
5338
5415
 
5339
- # List ListEntryGroups response.
5416
+ # List entry groups response.
5340
5417
  class GoogleCloudDataplexV1ListEntryGroupsResponse
5341
5418
  include Google::Apis::Core::Hashable
5342
5419
 
5343
- # ListEntryGroups under the given parent location.
5420
+ # Entry groups under the given parent location.
5344
5421
  # Corresponds to the JSON property `entryGroups`
5345
5422
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryGroup>]
5346
5423
  attr_accessor :entry_groups
@@ -5351,7 +5428,7 @@ module Google
5351
5428
  # @return [String]
5352
5429
  attr_accessor :next_page_token
5353
5430
 
5354
- # Locations that could not be reached.
5431
+ # Locations that the service couldn't reach.
5355
5432
  # Corresponds to the JSON property `unreachableLocations`
5356
5433
  # @return [Array<String>]
5357
5434
  attr_accessor :unreachable_locations
@@ -5368,11 +5445,11 @@ module Google
5368
5445
  end
5369
5446
  end
5370
5447
 
5371
- # List EntryTypes response
5448
+ # List EntryTypes response.
5372
5449
  class GoogleCloudDataplexV1ListEntryTypesResponse
5373
5450
  include Google::Apis::Core::Hashable
5374
5451
 
5375
- # ListEntryTypes under the given parent location.
5452
+ # EntryTypes under the given parent location.
5376
5453
  # Corresponds to the JSON property `entryTypes`
5377
5454
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryType>]
5378
5455
  attr_accessor :entry_types
@@ -5383,7 +5460,7 @@ module Google
5383
5460
  # @return [String]
5384
5461
  attr_accessor :next_page_token
5385
5462
 
5386
- # Locations that could not be reached.
5463
+ # Locations that the service couldn't reach.
5387
5464
  # Corresponds to the JSON property `unreachableLocations`
5388
5465
  # @return [Array<String>]
5389
5466
  attr_accessor :unreachable_locations
@@ -5484,6 +5561,38 @@ module Google
5484
5561
  end
5485
5562
  end
5486
5563
 
5564
+ # List metadata jobs response.
5565
+ class GoogleCloudDataplexV1ListMetadataJobsResponse
5566
+ include Google::Apis::Core::Hashable
5567
+
5568
+ # Metadata jobs under the specified parent location.
5569
+ # Corresponds to the JSON property `metadataJobs`
5570
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJob>]
5571
+ attr_accessor :metadata_jobs
5572
+
5573
+ # A token to retrieve the next page of results. If there are no more results in
5574
+ # the list, the value is empty.
5575
+ # Corresponds to the JSON property `nextPageToken`
5576
+ # @return [String]
5577
+ attr_accessor :next_page_token
5578
+
5579
+ # Locations that the service couldn't reach.
5580
+ # Corresponds to the JSON property `unreachableLocations`
5581
+ # @return [Array<String>]
5582
+ attr_accessor :unreachable_locations
5583
+
5584
+ def initialize(**args)
5585
+ update!(**args)
5586
+ end
5587
+
5588
+ # Update properties of this object
5589
+ def update!(**args)
5590
+ @metadata_jobs = args[:metadata_jobs] if args.key?(:metadata_jobs)
5591
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
5592
+ @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
5593
+ end
5594
+ end
5595
+
5487
5596
  # List metadata partitions response.
5488
5597
  class GoogleCloudDataplexV1ListPartitionsResponse
5489
5598
  include Google::Apis::Core::Hashable
@@ -5594,6 +5703,281 @@ module Google
5594
5703
  end
5595
5704
  end
5596
5705
 
5706
+ # A metadata job resource.
5707
+ class GoogleCloudDataplexV1MetadataJob
5708
+ include Google::Apis::Core::Hashable
5709
+
5710
+ # Output only. The time when the metadata job was created.
5711
+ # Corresponds to the JSON property `createTime`
5712
+ # @return [String]
5713
+ attr_accessor :create_time
5714
+
5715
+ # Results from a metadata import job.
5716
+ # Corresponds to the JSON property `importResult`
5717
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJobImportJobResult]
5718
+ attr_accessor :import_result
5719
+
5720
+ # Job specification for a metadata import job
5721
+ # Corresponds to the JSON property `importSpec`
5722
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJobImportJobSpec]
5723
+ attr_accessor :import_spec
5724
+
5725
+ # Optional. User-defined labels.
5726
+ # Corresponds to the JSON property `labels`
5727
+ # @return [Hash<String,String>]
5728
+ attr_accessor :labels
5729
+
5730
+ # Output only. The name of the resource that the configuration is applied to, in
5731
+ # the format projects/`project_number`/locations/`location_id`/metadataJobs/`
5732
+ # metadata_job_id`.
5733
+ # Corresponds to the JSON property `name`
5734
+ # @return [String]
5735
+ attr_accessor :name
5736
+
5737
+ # Metadata job status.
5738
+ # Corresponds to the JSON property `status`
5739
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJobStatus]
5740
+ attr_accessor :status
5741
+
5742
+ #
5743
+ # Corresponds to the JSON property `type`
5744
+ # @return [String]
5745
+ attr_accessor :type
5746
+
5747
+ # Output only. A system-generated, globally unique ID for the metadata job. If
5748
+ # the metadata job is deleted and then re-created with the same name, this ID is
5749
+ # different.
5750
+ # Corresponds to the JSON property `uid`
5751
+ # @return [String]
5752
+ attr_accessor :uid
5753
+
5754
+ # Output only. The time when the metadata job was updated.
5755
+ # Corresponds to the JSON property `updateTime`
5756
+ # @return [String]
5757
+ attr_accessor :update_time
5758
+
5759
+ def initialize(**args)
5760
+ update!(**args)
5761
+ end
5762
+
5763
+ # Update properties of this object
5764
+ def update!(**args)
5765
+ @create_time = args[:create_time] if args.key?(:create_time)
5766
+ @import_result = args[:import_result] if args.key?(:import_result)
5767
+ @import_spec = args[:import_spec] if args.key?(:import_spec)
5768
+ @labels = args[:labels] if args.key?(:labels)
5769
+ @name = args[:name] if args.key?(:name)
5770
+ @status = args[:status] if args.key?(:status)
5771
+ @type = args[:type] if args.key?(:type)
5772
+ @uid = args[:uid] if args.key?(:uid)
5773
+ @update_time = args[:update_time] if args.key?(:update_time)
5774
+ end
5775
+ end
5776
+
5777
+ # Results from a metadata import job.
5778
+ class GoogleCloudDataplexV1MetadataJobImportJobResult
5779
+ include Google::Apis::Core::Hashable
5780
+
5781
+ # Output only. The total number of entries that were created.
5782
+ # Corresponds to the JSON property `createdEntries`
5783
+ # @return [Fixnum]
5784
+ attr_accessor :created_entries
5785
+
5786
+ # Output only. The total number of entries that were deleted.
5787
+ # Corresponds to the JSON property `deletedEntries`
5788
+ # @return [Fixnum]
5789
+ attr_accessor :deleted_entries
5790
+
5791
+ # Output only. The total number of entries that were recreated.
5792
+ # Corresponds to the JSON property `recreatedEntries`
5793
+ # @return [Fixnum]
5794
+ attr_accessor :recreated_entries
5795
+
5796
+ # Output only. The total number of entries that were unchanged.
5797
+ # Corresponds to the JSON property `unchangedEntries`
5798
+ # @return [Fixnum]
5799
+ attr_accessor :unchanged_entries
5800
+
5801
+ # Output only. The time when the status was updated.
5802
+ # Corresponds to the JSON property `updateTime`
5803
+ # @return [String]
5804
+ attr_accessor :update_time
5805
+
5806
+ # Output only. The total number of entries that were updated.
5807
+ # Corresponds to the JSON property `updatedEntries`
5808
+ # @return [Fixnum]
5809
+ attr_accessor :updated_entries
5810
+
5811
+ def initialize(**args)
5812
+ update!(**args)
5813
+ end
5814
+
5815
+ # Update properties of this object
5816
+ def update!(**args)
5817
+ @created_entries = args[:created_entries] if args.key?(:created_entries)
5818
+ @deleted_entries = args[:deleted_entries] if args.key?(:deleted_entries)
5819
+ @recreated_entries = args[:recreated_entries] if args.key?(:recreated_entries)
5820
+ @unchanged_entries = args[:unchanged_entries] if args.key?(:unchanged_entries)
5821
+ @update_time = args[:update_time] if args.key?(:update_time)
5822
+ @updated_entries = args[:updated_entries] if args.key?(:updated_entries)
5823
+ end
5824
+ end
5825
+
5826
+ # Job specification for a metadata import job
5827
+ class GoogleCloudDataplexV1MetadataJobImportJobSpec
5828
+ include Google::Apis::Core::Hashable
5829
+
5830
+ # Required. The sync mode for aspects. Only INCREMENTAL mode is supported for
5831
+ # aspects. An aspect is modified only if the metadata import file includes a
5832
+ # reference to the aspect in the update_mask field and the aspect_keys field.
5833
+ # Corresponds to the JSON property `aspectSyncMode`
5834
+ # @return [String]
5835
+ attr_accessor :aspect_sync_mode
5836
+
5837
+ # Required. The sync mode for entries. Only FULL mode is supported for entries.
5838
+ # All entries in the job's scope are modified. If an entry exists in Dataplex
5839
+ # but isn't included in the metadata import file, the entry is deleted when you
5840
+ # run the metadata job.
5841
+ # Corresponds to the JSON property `entrySyncMode`
5842
+ # @return [String]
5843
+ attr_accessor :entry_sync_mode
5844
+
5845
+ # Optional. The level of logs to write to Cloud Logging for this job.Debug-level
5846
+ # logs provide highly-detailed information for troubleshooting, but their
5847
+ # increased verbosity could incur additional costs (https://cloud.google.com/
5848
+ # stackdriver/pricing) that might not be merited for all jobs.If unspecified,
5849
+ # defaults to INFO.
5850
+ # Corresponds to the JSON property `logLevel`
5851
+ # @return [String]
5852
+ attr_accessor :log_level
5853
+
5854
+ # A boundary on the scope of impact that the metadata import job can have.
5855
+ # Corresponds to the JSON property `scope`
5856
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope]
5857
+ attr_accessor :scope
5858
+
5859
+ # Optional. The time when the process that created the metadata import files
5860
+ # began.
5861
+ # Corresponds to the JSON property `sourceCreateTime`
5862
+ # @return [String]
5863
+ attr_accessor :source_create_time
5864
+
5865
+ # Optional. The URI of a Cloud Storage bucket or folder (beginning with gs://
5866
+ # and ending with /) that contains the metadata import files for this job.A
5867
+ # metadata import file defines the values to set for each of the entries and
5868
+ # aspects in a metadata job. For more information about how to create a metadata
5869
+ # import file and the file requirements, see Metadata import file (https://cloud.
5870
+ # google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide
5871
+ # multiple metadata import files in the same metadata job. The bucket or folder
5872
+ # must contain at least one metadata import file, in JSON Lines format (either .
5873
+ # json or .jsonl file extension).In FULL entry sync mode, don't save the
5874
+ # metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution:
5875
+ # If the metadata import file contains no data, all entries and aspects that
5876
+ # belong to the job's scope are deleted.
5877
+ # Corresponds to the JSON property `sourceStorageUri`
5878
+ # @return [String]
5879
+ attr_accessor :source_storage_uri
5880
+
5881
+ def initialize(**args)
5882
+ update!(**args)
5883
+ end
5884
+
5885
+ # Update properties of this object
5886
+ def update!(**args)
5887
+ @aspect_sync_mode = args[:aspect_sync_mode] if args.key?(:aspect_sync_mode)
5888
+ @entry_sync_mode = args[:entry_sync_mode] if args.key?(:entry_sync_mode)
5889
+ @log_level = args[:log_level] if args.key?(:log_level)
5890
+ @scope = args[:scope] if args.key?(:scope)
5891
+ @source_create_time = args[:source_create_time] if args.key?(:source_create_time)
5892
+ @source_storage_uri = args[:source_storage_uri] if args.key?(:source_storage_uri)
5893
+ end
5894
+ end
5895
+
5896
+ # A boundary on the scope of impact that the metadata import job can have.
5897
+ class GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope
5898
+ include Google::Apis::Core::Hashable
5899
+
5900
+ # Optional. The aspect types that are in scope for the import job, specified as
5901
+ # relative resource names in the format projects/`project_number_or_id`/
5902
+ # locations/`location_id`/aspectTypes/`aspect_type_id`. The job modifies only
5903
+ # the aspects that belong to these aspect types.If the metadata import file
5904
+ # attempts to modify an aspect whose type isn't included in this list, the
5905
+ # import job is halted before modifying any entries or aspects.The location of
5906
+ # an aspect type must either match the location of the job, or the aspect type
5907
+ # must be global.
5908
+ # Corresponds to the JSON property `aspectTypes`
5909
+ # @return [Array<String>]
5910
+ attr_accessor :aspect_types
5911
+
5912
+ # Required. The entry group that is in scope for the import job, specified as a
5913
+ # relative resource name in the format projects/`project_number_or_id`/locations/
5914
+ # `location_id`/entryGroups/`entry_group_id`. Only entries that belong to the
5915
+ # specified entry group are affected by the job.Must contain exactly one element.
5916
+ # The entry group and the job must be in the same location.
5917
+ # Corresponds to the JSON property `entryGroups`
5918
+ # @return [Array<String>]
5919
+ attr_accessor :entry_groups
5920
+
5921
+ # Required. The entry types that are in scope for the import job, specified as
5922
+ # relative resource names in the format projects/`project_number_or_id`/
5923
+ # locations/`location_id`/entryTypes/`entry_type_id`. The job modifies only the
5924
+ # entries that belong to these entry types.If the metadata import file attempts
5925
+ # to modify an entry whose type isn't included in this list, the import job is
5926
+ # halted before modifying any entries or aspects.The location of an entry type
5927
+ # must either match the location of the job, or the entry type must be global.
5928
+ # Corresponds to the JSON property `entryTypes`
5929
+ # @return [Array<String>]
5930
+ attr_accessor :entry_types
5931
+
5932
+ def initialize(**args)
5933
+ update!(**args)
5934
+ end
5935
+
5936
+ # Update properties of this object
5937
+ def update!(**args)
5938
+ @aspect_types = args[:aspect_types] if args.key?(:aspect_types)
5939
+ @entry_groups = args[:entry_groups] if args.key?(:entry_groups)
5940
+ @entry_types = args[:entry_types] if args.key?(:entry_types)
5941
+ end
5942
+ end
5943
+
5944
+ # Metadata job status.
5945
+ class GoogleCloudDataplexV1MetadataJobStatus
5946
+ include Google::Apis::Core::Hashable
5947
+
5948
+ # Output only. Progress tracking.
5949
+ # Corresponds to the JSON property `completionPercent`
5950
+ # @return [Fixnum]
5951
+ attr_accessor :completion_percent
5952
+
5953
+ # Output only. Message relating to the progression of a metadata job.
5954
+ # Corresponds to the JSON property `message`
5955
+ # @return [String]
5956
+ attr_accessor :message
5957
+
5958
+ # Output only. State of the metadata job.
5959
+ # Corresponds to the JSON property `state`
5960
+ # @return [String]
5961
+ attr_accessor :state
5962
+
5963
+ # Output only. The time when the status was updated.
5964
+ # Corresponds to the JSON property `updateTime`
5965
+ # @return [String]
5966
+ attr_accessor :update_time
5967
+
5968
+ def initialize(**args)
5969
+ update!(**args)
5970
+ end
5971
+
5972
+ # Update properties of this object
5973
+ def update!(**args)
5974
+ @completion_percent = args[:completion_percent] if args.key?(:completion_percent)
5975
+ @message = args[:message] if args.key?(:message)
5976
+ @state = args[:state] if args.key?(:state)
5977
+ @update_time = args[:update_time] if args.key?(:update_time)
5978
+ end
5979
+ end
5980
+
5597
5981
  # Represents the metadata of a long-running operation.
5598
5982
  class GoogleCloudDataplexV1OperationMetadata
5599
5983
  include Google::Apis::Core::Hashable
@@ -5996,7 +6380,8 @@ module Google
5996
6380
  class GoogleCloudDataplexV1SearchEntriesResponse
5997
6381
  include Google::Apis::Core::Hashable
5998
6382
 
5999
- # Pagination token.
6383
+ # Token to retrieve the next page of results, or empty if there are no more
6384
+ # results in the list.
6000
6385
  # Corresponds to the JSON property `nextPageToken`
6001
6386
  # @return [String]
6002
6387
  attr_accessor :next_page_token
@@ -6006,12 +6391,14 @@ module Google
6006
6391
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1SearchEntriesResult>]
6007
6392
  attr_accessor :results
6008
6393
 
6009
- # The estimated total number of matching entries. Not guaranteed to be accurate.
6394
+ # The estimated total number of matching entries. This number isn't guaranteed
6395
+ # to be accurate.
6010
6396
  # Corresponds to the JSON property `totalSize`
6011
6397
  # @return [Fixnum]
6012
6398
  attr_accessor :total_size
6013
6399
 
6014
- # Unreachable locations. Search results don't include data from those locations.
6400
+ # Locations that the service couldn't reach. Search results don't include data
6401
+ # from these locations.
6015
6402
  # Corresponds to the JSON property `unreachable`
6016
6403
  # @return [Array<String>]
6017
6404
  attr_accessor :unreachable
@@ -6033,8 +6420,8 @@ module Google
6033
6420
  class GoogleCloudDataplexV1SearchEntriesResult
6034
6421
  include Google::Apis::Core::Hashable
6035
6422
 
6036
- # An entry is a representation of a data asset which can be described by various
6037
- # metadata.
6423
+ # An entry is a representation of a data resource that can be described by
6424
+ # various metadata.
6038
6425
  # Corresponds to the JSON property `dataplexEntry`
6039
6426
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry]
6040
6427
  attr_accessor :dataplex_entry
@@ -6067,8 +6454,8 @@ module Google
6067
6454
  class GoogleCloudDataplexV1SearchEntriesResultSnippets
6068
6455
  include Google::Apis::Core::Hashable
6069
6456
 
6070
- # An entry is a representation of a data asset which can be described by various
6071
- # metadata.
6457
+ # An entry is a representation of a data resource that can be described by
6458
+ # various metadata.
6072
6459
  # Corresponds to the JSON property `dataplexEntry`
6073
6460
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry]
6074
6461
  attr_accessor :dataplex_entry