google-apis-dataplex_v1 0.49.0 → 0.51.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -333,6 +333,390 @@ module Google
333
333
  end
334
334
  end
335
335
 
336
+ # An aspect is a single piece of metadata describing an entry.
337
+ class GoogleCloudDataplexV1Aspect
338
+ include Google::Apis::Core::Hashable
339
+
340
+ # AspectSource contains source system related information for the aspect.
341
+ # Corresponds to the JSON property `aspectSource`
342
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectSource]
343
+ attr_accessor :aspect_source
344
+
345
+ # Output only. The resource name of the type used to create this Aspect.
346
+ # Corresponds to the JSON property `aspectType`
347
+ # @return [String]
348
+ attr_accessor :aspect_type
349
+
350
+ # Output only. The time when the Aspect was created.
351
+ # Corresponds to the JSON property `createTime`
352
+ # @return [String]
353
+ attr_accessor :create_time
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
+ # .
358
+ # Corresponds to the JSON property `data`
359
+ # @return [Hash<String,Object>]
360
+ attr_accessor :data
361
+
362
+ # Output only. The path in the entry under which the aspect is attached.
363
+ # Corresponds to the JSON property `path`
364
+ # @return [String]
365
+ attr_accessor :path
366
+
367
+ # Output only. The time when the Aspect was last updated.
368
+ # Corresponds to the JSON property `updateTime`
369
+ # @return [String]
370
+ attr_accessor :update_time
371
+
372
+ def initialize(**args)
373
+ update!(**args)
374
+ end
375
+
376
+ # Update properties of this object
377
+ def update!(**args)
378
+ @aspect_source = args[:aspect_source] if args.key?(:aspect_source)
379
+ @aspect_type = args[:aspect_type] if args.key?(:aspect_type)
380
+ @create_time = args[:create_time] if args.key?(:create_time)
381
+ @data = args[:data] if args.key?(:data)
382
+ @path = args[:path] if args.key?(:path)
383
+ @update_time = args[:update_time] if args.key?(:update_time)
384
+ end
385
+ end
386
+
387
+ # AspectSource contains source system related information for the aspect.
388
+ class GoogleCloudDataplexV1AspectSource
389
+ include Google::Apis::Core::Hashable
390
+
391
+ # The create time of the aspect in the source system.
392
+ # Corresponds to the JSON property `createTime`
393
+ # @return [String]
394
+ attr_accessor :create_time
395
+
396
+ # The update time of the aspect in the source system.
397
+ # Corresponds to the JSON property `updateTime`
398
+ # @return [String]
399
+ attr_accessor :update_time
400
+
401
+ def initialize(**args)
402
+ update!(**args)
403
+ end
404
+
405
+ # Update properties of this object
406
+ def update!(**args)
407
+ @create_time = args[:create_time] if args.key?(:create_time)
408
+ @update_time = args[:update_time] if args.key?(:update_time)
409
+ end
410
+ end
411
+
412
+ # Aspect Type is a template for creating Aspects, and represents the JSON-schema
413
+ # for a given Entry, e.g., BigQuery Table Schema.
414
+ class GoogleCloudDataplexV1AspectType
415
+ include Google::Apis::Core::Hashable
416
+
417
+ # Autorization for an Aspect Type.
418
+ # Corresponds to the JSON property `authorization`
419
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeAuthorization]
420
+ attr_accessor :authorization
421
+
422
+ # Output only. The time when the AspectType was created.
423
+ # Corresponds to the JSON property `createTime`
424
+ # @return [String]
425
+ attr_accessor :create_time
426
+
427
+ # Optional. Description of the AspectType.
428
+ # Corresponds to the JSON property `description`
429
+ # @return [String]
430
+ attr_accessor :description
431
+
432
+ # Optional. User friendly display name.
433
+ # Corresponds to the JSON property `displayName`
434
+ # @return [String]
435
+ attr_accessor :display_name
436
+
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.
440
+ # Corresponds to the JSON property `etag`
441
+ # @return [String]
442
+ attr_accessor :etag
443
+
444
+ # Optional. User-defined labels for the AspectType.
445
+ # Corresponds to the JSON property `labels`
446
+ # @return [Hash<String,String>]
447
+ attr_accessor :labels
448
+
449
+ # MetadataTemplate definition for AspectType
450
+ # Corresponds to the JSON property `metadataTemplate`
451
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate]
452
+ attr_accessor :metadata_template
453
+
454
+ # Output only. The relative resource name of the AspectType, of the form:
455
+ # projects/`project_number`/locations/`location_id`/aspectTypes/`aspect_type_id`.
456
+ # Corresponds to the JSON property `name`
457
+ # @return [String]
458
+ attr_accessor :name
459
+
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.
469
+ # Corresponds to the JSON property `uid`
470
+ # @return [String]
471
+ attr_accessor :uid
472
+
473
+ # Output only. The time when the AspectType was last updated.
474
+ # Corresponds to the JSON property `updateTime`
475
+ # @return [String]
476
+ attr_accessor :update_time
477
+
478
+ def initialize(**args)
479
+ update!(**args)
480
+ end
481
+
482
+ # Update properties of this object
483
+ def update!(**args)
484
+ @authorization = args[:authorization] if args.key?(:authorization)
485
+ @create_time = args[:create_time] if args.key?(:create_time)
486
+ @description = args[:description] if args.key?(:description)
487
+ @display_name = args[:display_name] if args.key?(:display_name)
488
+ @etag = args[:etag] if args.key?(:etag)
489
+ @labels = args[:labels] if args.key?(:labels)
490
+ @metadata_template = args[:metadata_template] if args.key?(:metadata_template)
491
+ @name = args[:name] if args.key?(:name)
492
+ @transfer_status = args[:transfer_status] if args.key?(:transfer_status)
493
+ @uid = args[:uid] if args.key?(:uid)
494
+ @update_time = args[:update_time] if args.key?(:update_time)
495
+ end
496
+ end
497
+
498
+ # Autorization for an Aspect Type.
499
+ class GoogleCloudDataplexV1AspectTypeAuthorization
500
+ include Google::Apis::Core::Hashable
501
+
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
504
+ # owned Types.
505
+ # Corresponds to the JSON property `alternateUsePermission`
506
+ # @return [String]
507
+ attr_accessor :alternate_use_permission
508
+
509
+ def initialize(**args)
510
+ update!(**args)
511
+ end
512
+
513
+ # Update properties of this object
514
+ def update!(**args)
515
+ @alternate_use_permission = args[:alternate_use_permission] if args.key?(:alternate_use_permission)
516
+ end
517
+ end
518
+
519
+ # MetadataTemplate definition for AspectType
520
+ class GoogleCloudDataplexV1AspectTypeMetadataTemplate
521
+ include Google::Apis::Core::Hashable
522
+
523
+ # Definition of the annotations of a field
524
+ # Corresponds to the JSON property `annotations`
525
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations]
526
+ attr_accessor :annotations
527
+
528
+ # MetadataTemplate definition for AspectType
529
+ # Corresponds to the JSON property `arrayItems`
530
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate]
531
+ attr_accessor :array_items
532
+
533
+ # Definition of the constraints of a field
534
+ # Corresponds to the JSON property `constraints`
535
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints]
536
+ attr_accessor :constraints
537
+
538
+ # Optional. The list of values for an enum type. Needs to be defined if the type
539
+ # is enum.
540
+ # Corresponds to the JSON property `enumValues`
541
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue>]
542
+ attr_accessor :enum_values
543
+
544
+ # Optional. Index is used to encode Template messages. The value of index can
545
+ # range between 1 and 2,147,483,647. Index must be unique within all fields in a
546
+ # Template. (Nested Templates can reuse indexes). Once a Template is defined,
547
+ # the index cannot be changed, because it identifies the field in the actual
548
+ # storage format. Index is a mandatory field, but it is optional for top level
549
+ # fields, and map/array "values" definitions.
550
+ # Corresponds to the JSON property `index`
551
+ # @return [Fixnum]
552
+ attr_accessor :index
553
+
554
+ # MetadataTemplate definition for AspectType
555
+ # Corresponds to the JSON property `mapItems`
556
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate]
557
+ attr_accessor :map_items
558
+
559
+ # Required. The name of the field.
560
+ # Corresponds to the JSON property `name`
561
+ # @return [String]
562
+ attr_accessor :name
563
+
564
+ # Optional. Field definition, needs to be specified if the type is record.
565
+ # Defines the nested fields.
566
+ # Corresponds to the JSON property `recordFields`
567
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectTypeMetadataTemplate>]
568
+ attr_accessor :record_fields
569
+
570
+ # 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).
574
+ # Corresponds to the JSON property `type`
575
+ # @return [String]
576
+ attr_accessor :type
577
+
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.
581
+ # Corresponds to the JSON property `typeId`
582
+ # @return [String]
583
+ attr_accessor :type_id
584
+
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.
589
+ # Corresponds to the JSON property `typeRef`
590
+ # @return [String]
591
+ attr_accessor :type_ref
592
+
593
+ def initialize(**args)
594
+ update!(**args)
595
+ end
596
+
597
+ # Update properties of this object
598
+ def update!(**args)
599
+ @annotations = args[:annotations] if args.key?(:annotations)
600
+ @array_items = args[:array_items] if args.key?(:array_items)
601
+ @constraints = args[:constraints] if args.key?(:constraints)
602
+ @enum_values = args[:enum_values] if args.key?(:enum_values)
603
+ @index = args[:index] if args.key?(:index)
604
+ @map_items = args[:map_items] if args.key?(:map_items)
605
+ @name = args[:name] if args.key?(:name)
606
+ @record_fields = args[:record_fields] if args.key?(:record_fields)
607
+ @type = args[:type] if args.key?(:type)
608
+ @type_id = args[:type_id] if args.key?(:type_id)
609
+ @type_ref = args[:type_ref] if args.key?(:type_ref)
610
+ end
611
+ end
612
+
613
+ # Definition of the annotations of a field
614
+ class GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations
615
+ include Google::Apis::Core::Hashable
616
+
617
+ # Optional. Marks a field as deprecated, a deprecation message can be included.
618
+ # Corresponds to the JSON property `deprecated`
619
+ # @return [String]
620
+ attr_accessor :deprecated
621
+
622
+ # Optional. Specify a description for a field
623
+ # Corresponds to the JSON property `description`
624
+ # @return [String]
625
+ attr_accessor :description
626
+
627
+ # Optional. Specify a displayname for a field.
628
+ # Corresponds to the JSON property `displayName`
629
+ # @return [String]
630
+ attr_accessor :display_name
631
+
632
+ # Optional. Specify a display order for a field. Display order can be used to
633
+ # reorder where a field is rendered
634
+ # Corresponds to the JSON property `displayOrder`
635
+ # @return [Fixnum]
636
+ attr_accessor :display_order
637
+
638
+ # Optional. String Type annotations can be used to specify special meaning to
639
+ # 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
641
+ # service qualified resource reference.
642
+ # Corresponds to the JSON property `stringType`
643
+ # @return [String]
644
+ attr_accessor :string_type
645
+
646
+ # Optional. Suggested hints for string fields. These can be used to suggest
647
+ # values to users, through an UI for example.
648
+ # Corresponds to the JSON property `stringValues`
649
+ # @return [Array<String>]
650
+ attr_accessor :string_values
651
+
652
+ def initialize(**args)
653
+ update!(**args)
654
+ end
655
+
656
+ # Update properties of this object
657
+ def update!(**args)
658
+ @deprecated = args[:deprecated] if args.key?(:deprecated)
659
+ @description = args[:description] if args.key?(:description)
660
+ @display_name = args[:display_name] if args.key?(:display_name)
661
+ @display_order = args[:display_order] if args.key?(:display_order)
662
+ @string_type = args[:string_type] if args.key?(:string_type)
663
+ @string_values = args[:string_values] if args.key?(:string_values)
664
+ end
665
+ end
666
+
667
+ # Definition of the constraints of a field
668
+ class GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints
669
+ include Google::Apis::Core::Hashable
670
+
671
+ # Optional. Marks this as an optional/required field.
672
+ # Corresponds to the JSON property `required`
673
+ # @return [Boolean]
674
+ attr_accessor :required
675
+ alias_method :required?, :required
676
+
677
+ def initialize(**args)
678
+ update!(**args)
679
+ end
680
+
681
+ # Update properties of this object
682
+ def update!(**args)
683
+ @required = args[:required] if args.key?(:required)
684
+ end
685
+ end
686
+
687
+ # Definition of Enumvalue (to be used by enum fields)
688
+ class GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue
689
+ include Google::Apis::Core::Hashable
690
+
691
+ # Optional. Optional deprecation message to be set if an enum value needs to be
692
+ # deprecated.
693
+ # Corresponds to the JSON property `deprecated`
694
+ # @return [String]
695
+ attr_accessor :deprecated
696
+
697
+ # Required. Index for the enum. Cannot be modified.
698
+ # Corresponds to the JSON property `index`
699
+ # @return [Fixnum]
700
+ attr_accessor :index
701
+
702
+ # Required. Name of the enumvalue. This is the actual value that the aspect will
703
+ # contain.
704
+ # Corresponds to the JSON property `name`
705
+ # @return [String]
706
+ attr_accessor :name
707
+
708
+ def initialize(**args)
709
+ update!(**args)
710
+ end
711
+
712
+ # Update properties of this object
713
+ def update!(**args)
714
+ @deprecated = args[:deprecated] if args.key?(:deprecated)
715
+ @index = args[:index] if args.key?(:index)
716
+ @name = args[:name] if args.key?(:name)
717
+ end
718
+ end
719
+
336
720
  # An asset represents a cloud resource that is being managed within a lake as a
337
721
  # member of a zone.
338
722
  class GoogleCloudDataplexV1Asset
@@ -1160,30 +1544,14 @@ module Google
1160
1544
  end
1161
1545
  end
1162
1546
 
1163
- # DataProfileResult defines the output of DataProfileScan. Each field of the
1164
- # table will have field type specific profile result.
1165
- class GoogleCloudDataplexV1DataProfileResult
1547
+ # The output of a DataDocumentation scan.
1548
+ class GoogleCloudDataplexV1DataDocumentationResult
1166
1549
  include Google::Apis::Core::Hashable
1167
1550
 
1168
- # The result of post scan actions of DataProfileScan job.
1169
- # Corresponds to the JSON property `postScanActionsResult`
1170
- # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultPostScanActionsResult]
1171
- attr_accessor :post_scan_actions_result
1172
-
1173
- # Contains name, type, mode and field type specific profile information.
1174
- # Corresponds to the JSON property `profile`
1175
- # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfile]
1176
- attr_accessor :profile
1177
-
1178
- # The count of rows scanned.
1179
- # Corresponds to the JSON property `rowCount`
1180
- # @return [Fixnum]
1181
- attr_accessor :row_count
1182
-
1183
- # The data scanned during processing (e.g. in incremental DataScan)
1184
- # Corresponds to the JSON property `scannedData`
1185
- # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ScannedData]
1186
- attr_accessor :scanned_data
1551
+ # Output only. The list of generated queries.
1552
+ # Corresponds to the JSON property `queries`
1553
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDocumentationResultQuery>]
1554
+ attr_accessor :queries
1187
1555
 
1188
1556
  def initialize(**args)
1189
1557
  update!(**args)
@@ -1191,22 +1559,95 @@ module Google
1191
1559
 
1192
1560
  # Update properties of this object
1193
1561
  def update!(**args)
1194
- @post_scan_actions_result = args[:post_scan_actions_result] if args.key?(:post_scan_actions_result)
1195
- @profile = args[:profile] if args.key?(:profile)
1196
- @row_count = args[:row_count] if args.key?(:row_count)
1197
- @scanned_data = args[:scanned_data] if args.key?(:scanned_data)
1562
+ @queries = args[:queries] if args.key?(:queries)
1198
1563
  end
1199
1564
  end
1200
1565
 
1201
- # The result of post scan actions of DataProfileScan job.
1202
- class GoogleCloudDataplexV1DataProfileResultPostScanActionsResult
1566
+ # A query in data documentation
1567
+ class GoogleCloudDataplexV1DataDocumentationResultQuery
1203
1568
  include Google::Apis::Core::Hashable
1204
1569
 
1205
- # The result of BigQuery export post scan action.
1206
- # Corresponds to the JSON property `bigqueryExportResult`
1207
- # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult]
1208
- attr_accessor :bigquery_export_result
1209
-
1570
+ # Output only. The description for the query.
1571
+ # Corresponds to the JSON property `description`
1572
+ # @return [String]
1573
+ attr_accessor :description
1574
+
1575
+ # Output only. The SQL query string which can be executed.
1576
+ # Corresponds to the JSON property `sql`
1577
+ # @return [String]
1578
+ attr_accessor :sql
1579
+
1580
+ def initialize(**args)
1581
+ update!(**args)
1582
+ end
1583
+
1584
+ # Update properties of this object
1585
+ def update!(**args)
1586
+ @description = args[:description] if args.key?(:description)
1587
+ @sql = args[:sql] if args.key?(:sql)
1588
+ end
1589
+ end
1590
+
1591
+ # DataDocumentation scan related spec.
1592
+ class GoogleCloudDataplexV1DataDocumentationSpec
1593
+ include Google::Apis::Core::Hashable
1594
+
1595
+ def initialize(**args)
1596
+ update!(**args)
1597
+ end
1598
+
1599
+ # Update properties of this object
1600
+ def update!(**args)
1601
+ end
1602
+ end
1603
+
1604
+ # DataProfileResult defines the output of DataProfileScan. Each field of the
1605
+ # table will have field type specific profile result.
1606
+ class GoogleCloudDataplexV1DataProfileResult
1607
+ include Google::Apis::Core::Hashable
1608
+
1609
+ # The result of post scan actions of DataProfileScan job.
1610
+ # Corresponds to the JSON property `postScanActionsResult`
1611
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultPostScanActionsResult]
1612
+ attr_accessor :post_scan_actions_result
1613
+
1614
+ # Contains name, type, mode and field type specific profile information.
1615
+ # Corresponds to the JSON property `profile`
1616
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfile]
1617
+ attr_accessor :profile
1618
+
1619
+ # The count of rows scanned.
1620
+ # Corresponds to the JSON property `rowCount`
1621
+ # @return [Fixnum]
1622
+ attr_accessor :row_count
1623
+
1624
+ # The data scanned during processing (e.g. in incremental DataScan)
1625
+ # Corresponds to the JSON property `scannedData`
1626
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ScannedData]
1627
+ attr_accessor :scanned_data
1628
+
1629
+ def initialize(**args)
1630
+ update!(**args)
1631
+ end
1632
+
1633
+ # Update properties of this object
1634
+ def update!(**args)
1635
+ @post_scan_actions_result = args[:post_scan_actions_result] if args.key?(:post_scan_actions_result)
1636
+ @profile = args[:profile] if args.key?(:profile)
1637
+ @row_count = args[:row_count] if args.key?(:row_count)
1638
+ @scanned_data = args[:scanned_data] if args.key?(:scanned_data)
1639
+ end
1640
+ end
1641
+
1642
+ # The result of post scan actions of DataProfileScan job.
1643
+ class GoogleCloudDataplexV1DataProfileResultPostScanActionsResult
1644
+ include Google::Apis::Core::Hashable
1645
+
1646
+ # The result of BigQuery export post scan action.
1647
+ # Corresponds to the JSON property `bigqueryExportResult`
1648
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult]
1649
+ attr_accessor :bigquery_export_result
1650
+
1210
1651
  def initialize(**args)
1211
1652
  update!(**args)
1212
1653
  end
@@ -2349,6 +2790,11 @@ module Google
2349
2790
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport]
2350
2791
  attr_accessor :bigquery_export
2351
2792
 
2793
+ # The configuration of notification report post scan action.
2794
+ # Corresponds to the JSON property `notificationReport`
2795
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport]
2796
+ attr_accessor :notification_report
2797
+
2352
2798
  def initialize(**args)
2353
2799
  update!(**args)
2354
2800
  end
@@ -2356,6 +2802,7 @@ module Google
2356
2802
  # Update properties of this object
2357
2803
  def update!(**args)
2358
2804
  @bigquery_export = args[:bigquery_export] if args.key?(:bigquery_export)
2805
+ @notification_report = args[:notification_report] if args.key?(:notification_report)
2359
2806
  end
2360
2807
  end
2361
2808
 
@@ -2380,6 +2827,116 @@ module Google
2380
2827
  end
2381
2828
  end
2382
2829
 
2830
+ # This trigger is triggered whenever a scan job run ends, regardless of the
2831
+ # result.
2832
+ class GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger
2833
+ include Google::Apis::Core::Hashable
2834
+
2835
+ def initialize(**args)
2836
+ update!(**args)
2837
+ end
2838
+
2839
+ # Update properties of this object
2840
+ def update!(**args)
2841
+ end
2842
+ end
2843
+
2844
+ # This trigger is triggered when the scan job itself fails, regardless of the
2845
+ # result.
2846
+ class GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger
2847
+ include Google::Apis::Core::Hashable
2848
+
2849
+ def initialize(**args)
2850
+ update!(**args)
2851
+ end
2852
+
2853
+ # Update properties of this object
2854
+ def update!(**args)
2855
+ end
2856
+ end
2857
+
2858
+ # The configuration of notification report post scan action.
2859
+ class GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport
2860
+ include Google::Apis::Core::Hashable
2861
+
2862
+ # This trigger is triggered whenever a scan job run ends, regardless of the
2863
+ # result.
2864
+ # Corresponds to the JSON property `jobEndTrigger`
2865
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger]
2866
+ attr_accessor :job_end_trigger
2867
+
2868
+ # This trigger is triggered when the scan job itself fails, regardless of the
2869
+ # result.
2870
+ # Corresponds to the JSON property `jobFailureTrigger`
2871
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger]
2872
+ attr_accessor :job_failure_trigger
2873
+
2874
+ # The individuals or groups who are designated to receive notifications upon
2875
+ # triggers.
2876
+ # Corresponds to the JSON property `recipients`
2877
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients]
2878
+ attr_accessor :recipients
2879
+
2880
+ # This trigger is triggered when the DQ score in the job result is less than a
2881
+ # specified input score.
2882
+ # Corresponds to the JSON property `scoreThresholdTrigger`
2883
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger]
2884
+ attr_accessor :score_threshold_trigger
2885
+
2886
+ def initialize(**args)
2887
+ update!(**args)
2888
+ end
2889
+
2890
+ # Update properties of this object
2891
+ def update!(**args)
2892
+ @job_end_trigger = args[:job_end_trigger] if args.key?(:job_end_trigger)
2893
+ @job_failure_trigger = args[:job_failure_trigger] if args.key?(:job_failure_trigger)
2894
+ @recipients = args[:recipients] if args.key?(:recipients)
2895
+ @score_threshold_trigger = args[:score_threshold_trigger] if args.key?(:score_threshold_trigger)
2896
+ end
2897
+ end
2898
+
2899
+ # The individuals or groups who are designated to receive notifications upon
2900
+ # triggers.
2901
+ class GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients
2902
+ include Google::Apis::Core::Hashable
2903
+
2904
+ # Optional. The email recipients who will receive the DataQualityScan results
2905
+ # report.
2906
+ # Corresponds to the JSON property `emails`
2907
+ # @return [Array<String>]
2908
+ attr_accessor :emails
2909
+
2910
+ def initialize(**args)
2911
+ update!(**args)
2912
+ end
2913
+
2914
+ # Update properties of this object
2915
+ def update!(**args)
2916
+ @emails = args[:emails] if args.key?(:emails)
2917
+ end
2918
+ end
2919
+
2920
+ # This trigger is triggered when the DQ score in the job result is less than a
2921
+ # specified input score.
2922
+ class GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger
2923
+ include Google::Apis::Core::Hashable
2924
+
2925
+ # Optional. The score range is in 0,100.
2926
+ # Corresponds to the JSON property `scoreThreshold`
2927
+ # @return [Float]
2928
+ attr_accessor :score_threshold
2929
+
2930
+ def initialize(**args)
2931
+ update!(**args)
2932
+ end
2933
+
2934
+ # Update properties of this object
2935
+ def update!(**args)
2936
+ @score_threshold = args[:score_threshold] if args.key?(:score_threshold)
2937
+ end
2938
+ end
2939
+
2383
2940
  # Represents a user-visible job which provides the insights for the related data
2384
2941
  # source.For example: Data Quality: generates queries based on the rules and
2385
2942
  # runs against the data to get data quality check results. Data Profile:
@@ -2399,6 +2956,16 @@ module Google
2399
2956
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataSource]
2400
2957
  attr_accessor :data
2401
2958
 
2959
+ # The output of a DataDocumentation scan.
2960
+ # Corresponds to the JSON property `dataDocumentationResult`
2961
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDocumentationResult]
2962
+ attr_accessor :data_documentation_result
2963
+
2964
+ # DataDocumentation scan related spec.
2965
+ # Corresponds to the JSON property `dataDocumentationSpec`
2966
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDocumentationSpec]
2967
+ attr_accessor :data_documentation_spec
2968
+
2402
2969
  # DataProfileResult defines the output of DataProfileScan. Each field of the
2403
2970
  # table will have field type specific profile result.
2404
2971
  # Corresponds to the JSON property `dataProfileResult`
@@ -2481,6 +3048,8 @@ module Google
2481
3048
  def update!(**args)
2482
3049
  @create_time = args[:create_time] if args.key?(:create_time)
2483
3050
  @data = args[:data] if args.key?(:data)
3051
+ @data_documentation_result = args[:data_documentation_result] if args.key?(:data_documentation_result)
3052
+ @data_documentation_spec = args[:data_documentation_spec] if args.key?(:data_documentation_spec)
2484
3053
  @data_profile_result = args[:data_profile_result] if args.key?(:data_profile_result)
2485
3054
  @data_profile_spec = args[:data_profile_spec] if args.key?(:data_profile_spec)
2486
3055
  @data_quality_result = args[:data_quality_result] if args.key?(:data_quality_result)
@@ -2847,6 +3416,16 @@ module Google
2847
3416
  class GoogleCloudDataplexV1DataScanJob
2848
3417
  include Google::Apis::Core::Hashable
2849
3418
 
3419
+ # The output of a DataDocumentation scan.
3420
+ # Corresponds to the JSON property `dataDocumentationResult`
3421
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDocumentationResult]
3422
+ attr_accessor :data_documentation_result
3423
+
3424
+ # DataDocumentation scan related spec.
3425
+ # Corresponds to the JSON property `dataDocumentationSpec`
3426
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataDocumentationSpec]
3427
+ attr_accessor :data_documentation_spec
3428
+
2850
3429
  # DataProfileResult defines the output of DataProfileScan. Each field of the
2851
3430
  # table will have field type specific profile result.
2852
3431
  # Corresponds to the JSON property `dataProfileResult`
@@ -2912,6 +3491,8 @@ module Google
2912
3491
 
2913
3492
  # Update properties of this object
2914
3493
  def update!(**args)
3494
+ @data_documentation_result = args[:data_documentation_result] if args.key?(:data_documentation_result)
3495
+ @data_documentation_spec = args[:data_documentation_spec] if args.key?(:data_documentation_spec)
2915
3496
  @data_profile_result = args[:data_profile_result] if args.key?(:data_profile_result)
2916
3497
  @data_profile_spec = args[:data_profile_spec] if args.key?(:data_profile_spec)
2917
3498
  @data_quality_result = args[:data_quality_result] if args.key?(:data_quality_result)
@@ -3290,35 +3871,427 @@ module Google
3290
3871
  # @return [String]
3291
3872
  attr_accessor :id
3292
3873
 
3293
- # Output only. The resource name of the entity, of the form: projects/`
3294
- # project_number`/locations/`location_id`/lakes/`lake_id`/zones/`zone_id`/
3295
- # entities/`id`.
3874
+ # Output only. The resource name of the entity, of the form: projects/`
3875
+ # project_number`/locations/`location_id`/lakes/`lake_id`/zones/`zone_id`/
3876
+ # entities/`id`.
3877
+ # Corresponds to the JSON property `name`
3878
+ # @return [String]
3879
+ attr_accessor :name
3880
+
3881
+ # Schema information describing the structure and layout of the data.
3882
+ # Corresponds to the JSON property `schema`
3883
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Schema]
3884
+ attr_accessor :schema
3885
+
3886
+ # Required. Immutable. Identifies the storage system of the entity data.
3887
+ # Corresponds to the JSON property `system`
3888
+ # @return [String]
3889
+ attr_accessor :system
3890
+
3891
+ # Required. Immutable. The type of entity.
3892
+ # Corresponds to the JSON property `type`
3893
+ # @return [String]
3894
+ attr_accessor :type
3895
+
3896
+ # Output only. System generated unique ID for the Entity. This ID will be
3897
+ # different if the Entity is deleted and re-created with the same name.
3898
+ # Corresponds to the JSON property `uid`
3899
+ # @return [String]
3900
+ attr_accessor :uid
3901
+
3902
+ # Output only. The time when the entity was last updated.
3903
+ # Corresponds to the JSON property `updateTime`
3904
+ # @return [String]
3905
+ attr_accessor :update_time
3906
+
3907
+ def initialize(**args)
3908
+ update!(**args)
3909
+ end
3910
+
3911
+ # Update properties of this object
3912
+ def update!(**args)
3913
+ @access = args[:access] if args.key?(:access)
3914
+ @asset = args[:asset] if args.key?(:asset)
3915
+ @catalog_entry = args[:catalog_entry] if args.key?(:catalog_entry)
3916
+ @compatibility = args[:compatibility] if args.key?(:compatibility)
3917
+ @create_time = args[:create_time] if args.key?(:create_time)
3918
+ @data_path = args[:data_path] if args.key?(:data_path)
3919
+ @data_path_pattern = args[:data_path_pattern] if args.key?(:data_path_pattern)
3920
+ @description = args[:description] if args.key?(:description)
3921
+ @display_name = args[:display_name] if args.key?(:display_name)
3922
+ @etag = args[:etag] if args.key?(:etag)
3923
+ @format = args[:format] if args.key?(:format)
3924
+ @id = args[:id] if args.key?(:id)
3925
+ @name = args[:name] if args.key?(:name)
3926
+ @schema = args[:schema] if args.key?(:schema)
3927
+ @system = args[:system] if args.key?(:system)
3928
+ @type = args[:type] if args.key?(:type)
3929
+ @uid = args[:uid] if args.key?(:uid)
3930
+ @update_time = args[:update_time] if args.key?(:update_time)
3931
+ end
3932
+ end
3933
+
3934
+ # Provides compatibility information for various metadata stores.
3935
+ class GoogleCloudDataplexV1EntityCompatibilityStatus
3936
+ include Google::Apis::Core::Hashable
3937
+
3938
+ # Provides compatibility information for a specific metadata store.
3939
+ # Corresponds to the JSON property `bigquery`
3940
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility]
3941
+ attr_accessor :bigquery
3942
+
3943
+ # Provides compatibility information for a specific metadata store.
3944
+ # Corresponds to the JSON property `hiveMetastore`
3945
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility]
3946
+ attr_accessor :hive_metastore
3947
+
3948
+ def initialize(**args)
3949
+ update!(**args)
3950
+ end
3951
+
3952
+ # Update properties of this object
3953
+ def update!(**args)
3954
+ @bigquery = args[:bigquery] if args.key?(:bigquery)
3955
+ @hive_metastore = args[:hive_metastore] if args.key?(:hive_metastore)
3956
+ end
3957
+ end
3958
+
3959
+ # Provides compatibility information for a specific metadata store.
3960
+ class GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility
3961
+ include Google::Apis::Core::Hashable
3962
+
3963
+ # Output only. Whether the entity is compatible and can be represented in the
3964
+ # metadata store.
3965
+ # Corresponds to the JSON property `compatible`
3966
+ # @return [Boolean]
3967
+ attr_accessor :compatible
3968
+ alias_method :compatible?, :compatible
3969
+
3970
+ # Output only. Provides additional detail if the entity is incompatible with the
3971
+ # metadata store.
3972
+ # Corresponds to the JSON property `reason`
3973
+ # @return [String]
3974
+ attr_accessor :reason
3975
+
3976
+ def initialize(**args)
3977
+ update!(**args)
3978
+ end
3979
+
3980
+ # Update properties of this object
3981
+ def update!(**args)
3982
+ @compatible = args[:compatible] if args.key?(:compatible)
3983
+ @reason = args[:reason] if args.key?(:reason)
3984
+ end
3985
+ end
3986
+
3987
+ # An entry is a representation of a data asset which can be described by various
3988
+ # metadata.
3989
+ class GoogleCloudDataplexV1Entry
3990
+ include Google::Apis::Core::Hashable
3991
+
3992
+ # Optional. The Aspects attached to the Entry. The key is either the resource
3993
+ # name of the aspect type (if the aspect is attached directly to the entry) or "
3994
+ # aspectType@path" if the aspect is attached to an entry's path.
3995
+ # Corresponds to the JSON property `aspects`
3996
+ # @return [Hash<String,Google::Apis::DataplexV1::GoogleCloudDataplexV1Aspect>]
3997
+ attr_accessor :aspects
3998
+
3999
+ # Output only. The time when the Entry was created.
4000
+ # Corresponds to the JSON property `createTime`
4001
+ # @return [String]
4002
+ attr_accessor :create_time
4003
+
4004
+ # EntrySource contains source system related information for the entry.
4005
+ # Corresponds to the JSON property `entrySource`
4006
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntrySource]
4007
+ attr_accessor :entry_source
4008
+
4009
+ # Required. Immutable. The resource name of the EntryType used to create this
4010
+ # Entry.
4011
+ # Corresponds to the JSON property `entryType`
4012
+ # @return [String]
4013
+ attr_accessor :entry_type
4014
+
4015
+ # Optional. A name for the entry that can reference it in an external system.
4016
+ # The maximum size of the field is 4000 characters.
4017
+ # Corresponds to the JSON property `fullyQualifiedName`
4018
+ # @return [String]
4019
+ attr_accessor :fully_qualified_name
4020
+
4021
+ # Identifier. The relative resource name of the Entry, of the form: projects/`
4022
+ # project`/locations/`location`/entryGroups/`entry_group`/entries/`entry`.
4023
+ # Corresponds to the JSON property `name`
4024
+ # @return [String]
4025
+ attr_accessor :name
4026
+
4027
+ # Optional. Immutable. The resource name of the parent entry.
4028
+ # Corresponds to the JSON property `parentEntry`
4029
+ # @return [String]
4030
+ attr_accessor :parent_entry
4031
+
4032
+ # Output only. The time when the Entry was last updated.
4033
+ # Corresponds to the JSON property `updateTime`
4034
+ # @return [String]
4035
+ attr_accessor :update_time
4036
+
4037
+ def initialize(**args)
4038
+ update!(**args)
4039
+ end
4040
+
4041
+ # Update properties of this object
4042
+ def update!(**args)
4043
+ @aspects = args[:aspects] if args.key?(:aspects)
4044
+ @create_time = args[:create_time] if args.key?(:create_time)
4045
+ @entry_source = args[:entry_source] if args.key?(:entry_source)
4046
+ @entry_type = args[:entry_type] if args.key?(:entry_type)
4047
+ @fully_qualified_name = args[:fully_qualified_name] if args.key?(:fully_qualified_name)
4048
+ @name = args[:name] if args.key?(:name)
4049
+ @parent_entry = args[:parent_entry] if args.key?(:parent_entry)
4050
+ @update_time = args[:update_time] if args.key?(:update_time)
4051
+ end
4052
+ end
4053
+
4054
+ # An Entry Group represents a logical grouping of one or more Entries.
4055
+ class GoogleCloudDataplexV1EntryGroup
4056
+ include Google::Apis::Core::Hashable
4057
+
4058
+ # Output only. The time when the EntryGroup was created.
4059
+ # Corresponds to the JSON property `createTime`
4060
+ # @return [String]
4061
+ attr_accessor :create_time
4062
+
4063
+ # Optional. Description of the EntryGroup.
4064
+ # Corresponds to the JSON property `description`
4065
+ # @return [String]
4066
+ attr_accessor :description
4067
+
4068
+ # Optional. User friendly display name.
4069
+ # Corresponds to the JSON property `displayName`
4070
+ # @return [String]
4071
+ attr_accessor :display_name
4072
+
4073
+ # This checksum is computed by the server based on the value of other fields,
4074
+ # and may be sent on update and delete requests to ensure the client has an up-
4075
+ # to-date value before proceeding.
4076
+ # Corresponds to the JSON property `etag`
4077
+ # @return [String]
4078
+ attr_accessor :etag
4079
+
4080
+ # Optional. User-defined labels for the EntryGroup.
4081
+ # Corresponds to the JSON property `labels`
4082
+ # @return [Hash<String,String>]
4083
+ attr_accessor :labels
4084
+
4085
+ # Output only. The relative resource name of the EntryGroup, of the form:
4086
+ # projects/`project_number`/locations/`location_id`/entryGroups/`entry_group_id`.
4087
+ # Corresponds to the JSON property `name`
4088
+ # @return [String]
4089
+ attr_accessor :name
4090
+
4091
+ # Output only. Denotes the transfer status of the Entry Group. It is unspecified
4092
+ # for Entry Group created from Dataplex API.
4093
+ # Corresponds to the JSON property `transferStatus`
4094
+ # @return [String]
4095
+ attr_accessor :transfer_status
4096
+
4097
+ # Output only. System generated globally unique ID for the EntryGroup. This ID
4098
+ # will be different if the EntryGroup is deleted and re-created with the same
4099
+ # name.
4100
+ # Corresponds to the JSON property `uid`
4101
+ # @return [String]
4102
+ attr_accessor :uid
4103
+
4104
+ # Output only. The time when the EntryGroup was last updated.
4105
+ # Corresponds to the JSON property `updateTime`
4106
+ # @return [String]
4107
+ attr_accessor :update_time
4108
+
4109
+ def initialize(**args)
4110
+ update!(**args)
4111
+ end
4112
+
4113
+ # Update properties of this object
4114
+ def update!(**args)
4115
+ @create_time = args[:create_time] if args.key?(:create_time)
4116
+ @description = args[:description] if args.key?(:description)
4117
+ @display_name = args[:display_name] if args.key?(:display_name)
4118
+ @etag = args[:etag] if args.key?(:etag)
4119
+ @labels = args[:labels] if args.key?(:labels)
4120
+ @name = args[:name] if args.key?(:name)
4121
+ @transfer_status = args[:transfer_status] if args.key?(:transfer_status)
4122
+ @uid = args[:uid] if args.key?(:uid)
4123
+ @update_time = args[:update_time] if args.key?(:update_time)
4124
+ end
4125
+ end
4126
+
4127
+ # EntrySource contains source system related information for the entry.
4128
+ class GoogleCloudDataplexV1EntrySource
4129
+ include Google::Apis::Core::Hashable
4130
+
4131
+ # Immutable. The ancestors of the Entry in the source system.
4132
+ # Corresponds to the JSON property `ancestors`
4133
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EntrySourceAncestor>]
4134
+ attr_accessor :ancestors
4135
+
4136
+ # The create time of the resource in the source system.
4137
+ # Corresponds to the JSON property `createTime`
4138
+ # @return [String]
4139
+ attr_accessor :create_time
4140
+
4141
+ # Description of the Entry. The maximum size of the field is 2000 characters.
4142
+ # Corresponds to the JSON property `description`
4143
+ # @return [String]
4144
+ attr_accessor :description
4145
+
4146
+ # User friendly display name. The maximum size of the field is 500 characters.
4147
+ # Corresponds to the JSON property `displayName`
4148
+ # @return [String]
4149
+ attr_accessor :display_name
4150
+
4151
+ # User-defined labels. The maximum size of keys and values is 128 characters
4152
+ # each.
4153
+ # Corresponds to the JSON property `labels`
4154
+ # @return [Hash<String,String>]
4155
+ attr_accessor :labels
4156
+
4157
+ # The platform containing the source system. The maximum size of the field is 64
4158
+ # characters.
4159
+ # Corresponds to the JSON property `platform`
4160
+ # @return [String]
4161
+ attr_accessor :platform
4162
+
4163
+ # The name of the resource in the source system. The maximum size of the field
4164
+ # is 4000 characters.
4165
+ # Corresponds to the JSON property `resource`
4166
+ # @return [String]
4167
+ attr_accessor :resource
4168
+
4169
+ # The name of the source system. The maximum size of the field is 64 characters.
4170
+ # Corresponds to the JSON property `system`
4171
+ # @return [String]
4172
+ attr_accessor :system
4173
+
4174
+ # The update time of the resource in the source system.
4175
+ # Corresponds to the JSON property `updateTime`
4176
+ # @return [String]
4177
+ attr_accessor :update_time
4178
+
4179
+ def initialize(**args)
4180
+ update!(**args)
4181
+ end
4182
+
4183
+ # Update properties of this object
4184
+ def update!(**args)
4185
+ @ancestors = args[:ancestors] if args.key?(:ancestors)
4186
+ @create_time = args[:create_time] if args.key?(:create_time)
4187
+ @description = args[:description] if args.key?(:description)
4188
+ @display_name = args[:display_name] if args.key?(:display_name)
4189
+ @labels = args[:labels] if args.key?(:labels)
4190
+ @platform = args[:platform] if args.key?(:platform)
4191
+ @resource = args[:resource] if args.key?(:resource)
4192
+ @system = args[:system] if args.key?(:system)
4193
+ @update_time = args[:update_time] if args.key?(:update_time)
4194
+ end
4195
+ end
4196
+
4197
+ # Ancestor contains information about individual items in the hierarchy of an
4198
+ # Entry.
4199
+ class GoogleCloudDataplexV1EntrySourceAncestor
4200
+ include Google::Apis::Core::Hashable
4201
+
4202
+ # Optional. The name of the ancestor resource.
4203
+ # Corresponds to the JSON property `name`
4204
+ # @return [String]
4205
+ attr_accessor :name
4206
+
4207
+ # Optional. The type of the ancestor resource.
4208
+ # Corresponds to the JSON property `type`
4209
+ # @return [String]
4210
+ attr_accessor :type
4211
+
4212
+ def initialize(**args)
4213
+ update!(**args)
4214
+ end
4215
+
4216
+ # Update properties of this object
4217
+ def update!(**args)
4218
+ @name = args[:name] if args.key?(:name)
4219
+ @type = args[:type] if args.key?(:type)
4220
+ end
4221
+ end
4222
+
4223
+ # Entry Type is a template for creating Entries.
4224
+ class GoogleCloudDataplexV1EntryType
4225
+ include Google::Apis::Core::Hashable
4226
+
4227
+ # Authorization for an Entry Type.
4228
+ # Corresponds to the JSON property `authorization`
4229
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryTypeAuthorization]
4230
+ attr_accessor :authorization
4231
+
4232
+ # Output only. The time when the EntryType was created.
4233
+ # Corresponds to the JSON property `createTime`
4234
+ # @return [String]
4235
+ attr_accessor :create_time
4236
+
4237
+ # Optional. Description of the EntryType.
4238
+ # Corresponds to the JSON property `description`
4239
+ # @return [String]
4240
+ attr_accessor :description
4241
+
4242
+ # Optional. User friendly display name.
4243
+ # Corresponds to the JSON property `displayName`
4244
+ # @return [String]
4245
+ attr_accessor :display_name
4246
+
4247
+ # Optional. This checksum is computed by the server based on the value of other
4248
+ # fields, and may be sent on update and delete requests to ensure the client has
4249
+ # an up-to-date value before proceeding.
4250
+ # Corresponds to the JSON property `etag`
4251
+ # @return [String]
4252
+ attr_accessor :etag
4253
+
4254
+ # Optional. User-defined labels for the EntryType.
4255
+ # Corresponds to the JSON property `labels`
4256
+ # @return [Hash<String,String>]
4257
+ attr_accessor :labels
4258
+
4259
+ # Output only. The relative resource name of the EntryType, of the form:
4260
+ # projects/`project_number`/locations/`location_id`/entryTypes/`entry_type_id`.
3296
4261
  # Corresponds to the JSON property `name`
3297
4262
  # @return [String]
3298
4263
  attr_accessor :name
3299
4264
 
3300
- # Schema information describing the structure and layout of the data.
3301
- # Corresponds to the JSON property `schema`
3302
- # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Schema]
3303
- attr_accessor :schema
4265
+ # Optional. The platform that Entries of this type belongs to.
4266
+ # Corresponds to the JSON property `platform`
4267
+ # @return [String]
4268
+ attr_accessor :platform
3304
4269
 
3305
- # Required. Immutable. Identifies the storage system of the entity data.
4270
+ # AspectInfo for the entry type.
4271
+ # Corresponds to the JSON property `requiredAspects`
4272
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryTypeAspectInfo>]
4273
+ attr_accessor :required_aspects
4274
+
4275
+ # Optional. The system that Entries of this type belongs to. Examples include
4276
+ # CloudSQL, MariaDB etc
3306
4277
  # Corresponds to the JSON property `system`
3307
4278
  # @return [String]
3308
4279
  attr_accessor :system
3309
4280
 
3310
- # Required. Immutable. The type of entity.
3311
- # Corresponds to the JSON property `type`
3312
- # @return [String]
3313
- attr_accessor :type
4281
+ # Optional. Indicates the class this Entry Type belongs to, for example, TABLE,
4282
+ # DATABASE, MODEL.
4283
+ # Corresponds to the JSON property `typeAliases`
4284
+ # @return [Array<String>]
4285
+ attr_accessor :type_aliases
3314
4286
 
3315
- # Output only. System generated unique ID for the Entity. This ID will be
3316
- # different if the Entity is deleted and re-created with the same name.
4287
+ # Output only. System generated globally unique ID for the EntryType. This ID
4288
+ # will be different if the EntryType is deleted and re-created with the same
4289
+ # name.
3317
4290
  # Corresponds to the JSON property `uid`
3318
4291
  # @return [String]
3319
4292
  attr_accessor :uid
3320
4293
 
3321
- # Output only. The time when the entity was last updated.
4294
+ # Output only. The time when the EntryType was last updated.
3322
4295
  # Corresponds to the JSON property `updateTime`
3323
4296
  # @return [String]
3324
4297
  attr_accessor :update_time
@@ -3329,40 +4302,30 @@ module Google
3329
4302
 
3330
4303
  # Update properties of this object
3331
4304
  def update!(**args)
3332
- @access = args[:access] if args.key?(:access)
3333
- @asset = args[:asset] if args.key?(:asset)
3334
- @catalog_entry = args[:catalog_entry] if args.key?(:catalog_entry)
3335
- @compatibility = args[:compatibility] if args.key?(:compatibility)
4305
+ @authorization = args[:authorization] if args.key?(:authorization)
3336
4306
  @create_time = args[:create_time] if args.key?(:create_time)
3337
- @data_path = args[:data_path] if args.key?(:data_path)
3338
- @data_path_pattern = args[:data_path_pattern] if args.key?(:data_path_pattern)
3339
4307
  @description = args[:description] if args.key?(:description)
3340
4308
  @display_name = args[:display_name] if args.key?(:display_name)
3341
4309
  @etag = args[:etag] if args.key?(:etag)
3342
- @format = args[:format] if args.key?(:format)
3343
- @id = args[:id] if args.key?(:id)
4310
+ @labels = args[:labels] if args.key?(:labels)
3344
4311
  @name = args[:name] if args.key?(:name)
3345
- @schema = args[:schema] if args.key?(:schema)
4312
+ @platform = args[:platform] if args.key?(:platform)
4313
+ @required_aspects = args[:required_aspects] if args.key?(:required_aspects)
3346
4314
  @system = args[:system] if args.key?(:system)
3347
- @type = args[:type] if args.key?(:type)
4315
+ @type_aliases = args[:type_aliases] if args.key?(:type_aliases)
3348
4316
  @uid = args[:uid] if args.key?(:uid)
3349
4317
  @update_time = args[:update_time] if args.key?(:update_time)
3350
4318
  end
3351
4319
  end
3352
4320
 
3353
- # Provides compatibility information for various metadata stores.
3354
- class GoogleCloudDataplexV1EntityCompatibilityStatus
4321
+ #
4322
+ class GoogleCloudDataplexV1EntryTypeAspectInfo
3355
4323
  include Google::Apis::Core::Hashable
3356
4324
 
3357
- # Provides compatibility information for a specific metadata store.
3358
- # Corresponds to the JSON property `bigquery`
3359
- # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility]
3360
- attr_accessor :bigquery
3361
-
3362
- # Provides compatibility information for a specific metadata store.
3363
- # Corresponds to the JSON property `hiveMetastore`
3364
- # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility]
3365
- attr_accessor :hive_metastore
4325
+ # Required aspect type for the entry type.
4326
+ # Corresponds to the JSON property `type`
4327
+ # @return [String]
4328
+ attr_accessor :type
3366
4329
 
3367
4330
  def initialize(**args)
3368
4331
  update!(**args)
@@ -3370,27 +4333,20 @@ module Google
3370
4333
 
3371
4334
  # Update properties of this object
3372
4335
  def update!(**args)
3373
- @bigquery = args[:bigquery] if args.key?(:bigquery)
3374
- @hive_metastore = args[:hive_metastore] if args.key?(:hive_metastore)
4336
+ @type = args[:type] if args.key?(:type)
3375
4337
  end
3376
4338
  end
3377
4339
 
3378
- # Provides compatibility information for a specific metadata store.
3379
- class GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility
4340
+ # Authorization for an Entry Type.
4341
+ class GoogleCloudDataplexV1EntryTypeAuthorization
3380
4342
  include Google::Apis::Core::Hashable
3381
4343
 
3382
- # Output only. Whether the entity is compatible and can be represented in the
3383
- # metadata store.
3384
- # Corresponds to the JSON property `compatible`
3385
- # @return [Boolean]
3386
- attr_accessor :compatible
3387
- alias_method :compatible?, :compatible
3388
-
3389
- # Output only. Provides additional detail if the entity is incompatible with the
3390
- # metadata store.
3391
- # Corresponds to the JSON property `reason`
4344
+ # Immutable. The IAM permission grantable on the Entry Group to allow access to
4345
+ # instantiate Entries of Dataplex owned Entry Types, only settable for Dataplex
4346
+ # owned Types.
4347
+ # Corresponds to the JSON property `alternateUsePermission`
3392
4348
  # @return [String]
3393
- attr_accessor :reason
4349
+ attr_accessor :alternate_use_permission
3394
4350
 
3395
4351
  def initialize(**args)
3396
4352
  update!(**args)
@@ -3398,8 +4354,7 @@ module Google
3398
4354
 
3399
4355
  # Update properties of this object
3400
4356
  def update!(**args)
3401
- @compatible = args[:compatible] if args.key?(:compatible)
3402
- @reason = args[:reason] if args.key?(:reason)
4357
+ @alternate_use_permission = args[:alternate_use_permission] if args.key?(:alternate_use_permission)
3403
4358
  end
3404
4359
  end
3405
4360
 
@@ -3670,6 +4625,38 @@ module Google
3670
4625
  end
3671
4626
  end
3672
4627
 
4628
+ # Generate recommended DataQualityRules request.
4629
+ class GoogleCloudDataplexV1GenerateDataQualityRulesRequest
4630
+ include Google::Apis::Core::Hashable
4631
+
4632
+ def initialize(**args)
4633
+ update!(**args)
4634
+ end
4635
+
4636
+ # Update properties of this object
4637
+ def update!(**args)
4638
+ end
4639
+ end
4640
+
4641
+ # Generate recommended DataQualityRules response.
4642
+ class GoogleCloudDataplexV1GenerateDataQualityRulesResponse
4643
+ include Google::Apis::Core::Hashable
4644
+
4645
+ # Generated recommended `@link DataQualityRule`s.
4646
+ # Corresponds to the JSON property `rule`
4647
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualityRule>]
4648
+ attr_accessor :rule
4649
+
4650
+ def initialize(**args)
4651
+ update!(**args)
4652
+ end
4653
+
4654
+ # Update properties of this object
4655
+ def update!(**args)
4656
+ @rule = args[:rule] if args.key?(:rule)
4657
+ end
4658
+ end
4659
+
3673
4660
  # Payload associated with Governance related log events.
3674
4661
  class GoogleCloudDataplexV1GovernanceEvent
3675
4662
  include Google::Apis::Core::Hashable
@@ -4069,6 +5056,38 @@ module Google
4069
5056
  end
4070
5057
  end
4071
5058
 
5059
+ # List AspectTypes response
5060
+ class GoogleCloudDataplexV1ListAspectTypesResponse
5061
+ include Google::Apis::Core::Hashable
5062
+
5063
+ # ListAspectTypes under the given parent location.
5064
+ # Corresponds to the JSON property `aspectTypes`
5065
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectType>]
5066
+ attr_accessor :aspect_types
5067
+
5068
+ # Token to retrieve the next page of results, or empty if there are no more
5069
+ # results in the list.
5070
+ # Corresponds to the JSON property `nextPageToken`
5071
+ # @return [String]
5072
+ attr_accessor :next_page_token
5073
+
5074
+ # Locations that could not be reached.
5075
+ # Corresponds to the JSON property `unreachableLocations`
5076
+ # @return [Array<String>]
5077
+ attr_accessor :unreachable_locations
5078
+
5079
+ def initialize(**args)
5080
+ update!(**args)
5081
+ end
5082
+
5083
+ # Update properties of this object
5084
+ def update!(**args)
5085
+ @aspect_types = args[:aspect_types] if args.key?(:aspect_types)
5086
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
5087
+ @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
5088
+ end
5089
+ end
5090
+
4072
5091
  # List assets response.
4073
5092
  class GoogleCloudDataplexV1ListAssetsResponse
4074
5093
  include Google::Apis::Core::Hashable
@@ -4301,6 +5320,95 @@ module Google
4301
5320
  end
4302
5321
  end
4303
5322
 
5323
+ #
5324
+ class GoogleCloudDataplexV1ListEntriesResponse
5325
+ include Google::Apis::Core::Hashable
5326
+
5327
+ # The list of entries.
5328
+ # Corresponds to the JSON property `entries`
5329
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry>]
5330
+ attr_accessor :entries
5331
+
5332
+ # Pagination token.
5333
+ # Corresponds to the JSON property `nextPageToken`
5334
+ # @return [String]
5335
+ attr_accessor :next_page_token
5336
+
5337
+ def initialize(**args)
5338
+ update!(**args)
5339
+ end
5340
+
5341
+ # Update properties of this object
5342
+ def update!(**args)
5343
+ @entries = args[:entries] if args.key?(:entries)
5344
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
5345
+ end
5346
+ end
5347
+
5348
+ # List ListEntryGroups response.
5349
+ class GoogleCloudDataplexV1ListEntryGroupsResponse
5350
+ include Google::Apis::Core::Hashable
5351
+
5352
+ # ListEntryGroups under the given parent location.
5353
+ # Corresponds to the JSON property `entryGroups`
5354
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryGroup>]
5355
+ attr_accessor :entry_groups
5356
+
5357
+ # Token to retrieve the next page of results, or empty if there are no more
5358
+ # results in the list.
5359
+ # Corresponds to the JSON property `nextPageToken`
5360
+ # @return [String]
5361
+ attr_accessor :next_page_token
5362
+
5363
+ # Locations that could not be reached.
5364
+ # Corresponds to the JSON property `unreachableLocations`
5365
+ # @return [Array<String>]
5366
+ attr_accessor :unreachable_locations
5367
+
5368
+ def initialize(**args)
5369
+ update!(**args)
5370
+ end
5371
+
5372
+ # Update properties of this object
5373
+ def update!(**args)
5374
+ @entry_groups = args[:entry_groups] if args.key?(:entry_groups)
5375
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
5376
+ @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
5377
+ end
5378
+ end
5379
+
5380
+ # List EntryTypes response
5381
+ class GoogleCloudDataplexV1ListEntryTypesResponse
5382
+ include Google::Apis::Core::Hashable
5383
+
5384
+ # ListEntryTypes under the given parent location.
5385
+ # Corresponds to the JSON property `entryTypes`
5386
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryType>]
5387
+ attr_accessor :entry_types
5388
+
5389
+ # Token to retrieve the next page of results, or empty if there are no more
5390
+ # results in the list.
5391
+ # Corresponds to the JSON property `nextPageToken`
5392
+ # @return [String]
5393
+ attr_accessor :next_page_token
5394
+
5395
+ # Locations that could not be reached.
5396
+ # Corresponds to the JSON property `unreachableLocations`
5397
+ # @return [Array<String>]
5398
+ attr_accessor :unreachable_locations
5399
+
5400
+ def initialize(**args)
5401
+ update!(**args)
5402
+ end
5403
+
5404
+ # Update properties of this object
5405
+ def update!(**args)
5406
+ @entry_types = args[:entry_types] if args.key?(:entry_types)
5407
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
5408
+ @unreachable_locations = args[:unreachable_locations] if args.key?(:unreachable_locations)
5409
+ end
5410
+ end
5411
+
4304
5412
  # List environments response.
4305
5413
  class GoogleCloudDataplexV1ListEnvironmentsResponse
4306
5414
  include Google::Apis::Core::Hashable
@@ -4893,6 +6001,139 @@ module Google
4893
6001
  end
4894
6002
  end
4895
6003
 
6004
+ #
6005
+ class GoogleCloudDataplexV1SearchEntriesResponse
6006
+ include Google::Apis::Core::Hashable
6007
+
6008
+ # Pagination token.
6009
+ # Corresponds to the JSON property `nextPageToken`
6010
+ # @return [String]
6011
+ attr_accessor :next_page_token
6012
+
6013
+ # The results matching the search query.
6014
+ # Corresponds to the JSON property `results`
6015
+ # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1SearchEntriesResult>]
6016
+ attr_accessor :results
6017
+
6018
+ # The estimated total number of matching entries. Not guaranteed to be accurate.
6019
+ # Corresponds to the JSON property `totalSize`
6020
+ # @return [Fixnum]
6021
+ attr_accessor :total_size
6022
+
6023
+ # Unreachable locations. Search results don't include data from those locations.
6024
+ # Corresponds to the JSON property `unreachable`
6025
+ # @return [Array<String>]
6026
+ attr_accessor :unreachable
6027
+
6028
+ def initialize(**args)
6029
+ update!(**args)
6030
+ end
6031
+
6032
+ # Update properties of this object
6033
+ def update!(**args)
6034
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6035
+ @results = args[:results] if args.key?(:results)
6036
+ @total_size = args[:total_size] if args.key?(:total_size)
6037
+ @unreachable = args[:unreachable] if args.key?(:unreachable)
6038
+ end
6039
+ end
6040
+
6041
+ # A single result of a SearchEntries request.
6042
+ class GoogleCloudDataplexV1SearchEntriesResult
6043
+ include Google::Apis::Core::Hashable
6044
+
6045
+ # An entry is a representation of a data asset which can be described by various
6046
+ # metadata.
6047
+ # Corresponds to the JSON property `dataplexEntry`
6048
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry]
6049
+ attr_accessor :dataplex_entry
6050
+
6051
+ # Entry description.
6052
+ # Corresponds to the JSON property `description`
6053
+ # @return [String]
6054
+ attr_accessor :description
6055
+
6056
+ # Display name.
6057
+ # Corresponds to the JSON property `displayName`
6058
+ # @return [String]
6059
+ attr_accessor :display_name
6060
+
6061
+ # Resource name of the entry.
6062
+ # Corresponds to the JSON property `entry`
6063
+ # @return [String]
6064
+ attr_accessor :entry
6065
+
6066
+ # The entry type.
6067
+ # Corresponds to the JSON property `entryType`
6068
+ # @return [String]
6069
+ attr_accessor :entry_type
6070
+
6071
+ # Fully qualified name.
6072
+ # Corresponds to the JSON property `fullyQualifiedName`
6073
+ # @return [String]
6074
+ attr_accessor :fully_qualified_name
6075
+
6076
+ # Linked resource name.
6077
+ # Corresponds to the JSON property `linkedResource`
6078
+ # @return [String]
6079
+ attr_accessor :linked_resource
6080
+
6081
+ # The last modification timestamp.
6082
+ # Corresponds to the JSON property `modifyTime`
6083
+ # @return [String]
6084
+ attr_accessor :modify_time
6085
+
6086
+ # Relative resource name.
6087
+ # Corresponds to the JSON property `relativeResource`
6088
+ # @return [String]
6089
+ attr_accessor :relative_resource
6090
+
6091
+ # Snippets for the entry, contains HTML-style highlighting for matched tokens,
6092
+ # will be used in UI.
6093
+ # Corresponds to the JSON property `snippets`
6094
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1SearchEntriesResultSnippets]
6095
+ attr_accessor :snippets
6096
+
6097
+ def initialize(**args)
6098
+ update!(**args)
6099
+ end
6100
+
6101
+ # Update properties of this object
6102
+ def update!(**args)
6103
+ @dataplex_entry = args[:dataplex_entry] if args.key?(:dataplex_entry)
6104
+ @description = args[:description] if args.key?(:description)
6105
+ @display_name = args[:display_name] if args.key?(:display_name)
6106
+ @entry = args[:entry] if args.key?(:entry)
6107
+ @entry_type = args[:entry_type] if args.key?(:entry_type)
6108
+ @fully_qualified_name = args[:fully_qualified_name] if args.key?(:fully_qualified_name)
6109
+ @linked_resource = args[:linked_resource] if args.key?(:linked_resource)
6110
+ @modify_time = args[:modify_time] if args.key?(:modify_time)
6111
+ @relative_resource = args[:relative_resource] if args.key?(:relative_resource)
6112
+ @snippets = args[:snippets] if args.key?(:snippets)
6113
+ end
6114
+ end
6115
+
6116
+ # Snippets for the entry, contains HTML-style highlighting for matched tokens,
6117
+ # will be used in UI.
6118
+ class GoogleCloudDataplexV1SearchEntriesResultSnippets
6119
+ include Google::Apis::Core::Hashable
6120
+
6121
+ # An entry is a representation of a data asset which can be described by various
6122
+ # metadata.
6123
+ # Corresponds to the JSON property `dataplexEntry`
6124
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry]
6125
+ attr_accessor :dataplex_entry
6126
+
6127
+ def initialize(**args)
6128
+ update!(**args)
6129
+ end
6130
+
6131
+ # Update properties of this object
6132
+ def update!(**args)
6133
+ @dataplex_entry = args[:dataplex_entry] if args.key?(:dataplex_entry)
6134
+ end
6135
+ end
6136
+
4896
6137
  # Represents an active analyze session running for a user.
4897
6138
  class GoogleCloudDataplexV1Session
4898
6139
  include Google::Apis::Core::Hashable