google-cloud-dataplex-v1 2.9.0 → 2.10.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.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dataplex/v1/analyze_pb.rb +2 -25
  4. data/lib/google/cloud/dataplex/v1/approval_workflow_pb.rb +33 -0
  5. data/lib/google/cloud/dataplex/v1/bindings_override.rb +24 -24
  6. data/lib/google/cloud/dataplex/v1/business_glossary_pb.rb +3 -26
  7. data/lib/google/cloud/dataplex/v1/business_glossary_service/client.rb +2 -0
  8. data/lib/google/cloud/dataplex/v1/business_glossary_service/credentials.rb +4 -1
  9. data/lib/google/cloud/dataplex/v1/business_glossary_service/operations.rb +2 -0
  10. data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/client.rb +2 -0
  11. data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/operations.rb +2 -0
  12. data/lib/google/cloud/dataplex/v1/catalog_pb.rb +20 -27
  13. data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +1074 -73
  14. data/lib/google/cloud/dataplex/v1/catalog_service/credentials.rb +4 -1
  15. data/lib/google/cloud/dataplex/v1/catalog_service/operations.rb +2 -0
  16. data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +19 -0
  17. data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +1020 -82
  18. data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +2 -0
  19. data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +554 -0
  20. data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +18 -15
  21. data/lib/google/cloud/dataplex/v1/cmek_pb.rb +3 -26
  22. data/lib/google/cloud/dataplex/v1/cmek_service/client.rb +2 -0
  23. data/lib/google/cloud/dataplex/v1/cmek_service/credentials.rb +2 -1
  24. data/lib/google/cloud/dataplex/v1/cmek_service/operations.rb +2 -0
  25. data/lib/google/cloud/dataplex/v1/cmek_service/rest/client.rb +2 -0
  26. data/lib/google/cloud/dataplex/v1/cmek_service/rest/operations.rb +2 -0
  27. data/lib/google/cloud/dataplex/v1/content_pb.rb +3 -38
  28. data/lib/google/cloud/dataplex/v1/content_services_pb.rb +0 -49
  29. data/lib/google/cloud/dataplex/v1/data_discovery_pb.rb +4 -24
  30. data/lib/google/cloud/dataplex/v1/data_documentation_pb.rb +10 -24
  31. data/lib/google/cloud/dataplex/v1/data_product_service/client.rb +1644 -0
  32. data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/credentials.rb +7 -4
  33. data/lib/google/cloud/dataplex/v1/data_product_service/operations.rb +843 -0
  34. data/lib/google/cloud/dataplex/v1/data_product_service/paths.rb +231 -0
  35. data/lib/google/cloud/dataplex/v1/data_product_service/rest/client.rb +1533 -0
  36. data/lib/google/cloud/dataplex/v1/data_product_service/rest/operations.rb +956 -0
  37. data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/rest/service_stub.rb +284 -160
  38. data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/rest.rb +11 -10
  39. data/lib/google/cloud/dataplex/v1/{content_service.rb → data_product_service.rb} +15 -14
  40. data/lib/google/cloud/dataplex/v1/data_products_pb.rb +52 -0
  41. data/lib/google/cloud/dataplex/v1/data_products_services_pb.rb +69 -0
  42. data/lib/google/cloud/dataplex/v1/data_profile_pb.rb +4 -26
  43. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +13 -26
  44. data/lib/google/cloud/dataplex/v1/data_quality_rule_template_pb.rb +25 -0
  45. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +99 -1
  46. data/lib/google/cloud/dataplex/v1/data_scan_service/credentials.rb +4 -1
  47. data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +2 -0
  48. data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +21 -0
  49. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +92 -1
  50. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +2 -0
  51. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/service_stub.rb +62 -0
  52. data/lib/google/cloud/dataplex/v1/data_taxonomy_pb.rb +3 -27
  53. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/client.rb +2 -0
  54. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/credentials.rb +2 -1
  55. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/operations.rb +2 -0
  56. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/client.rb +2 -0
  57. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +2 -0
  58. data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +2 -664
  59. data/lib/google/cloud/dataplex/v1/dataplex_service/credentials.rb +4 -1
  60. data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +2 -0
  61. data/lib/google/cloud/dataplex/v1/dataplex_service/paths.rb +0 -21
  62. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +2 -622
  63. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +2 -0
  64. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/service_stub.rb +0 -368
  65. data/lib/google/cloud/dataplex/v1/datascans_common_pb.rb +3 -24
  66. data/lib/google/cloud/dataplex/v1/datascans_pb.rb +9 -31
  67. data/lib/google/cloud/dataplex/v1/datascans_services_pb.rb +2 -0
  68. data/lib/google/cloud/dataplex/v1/logs_pb.rb +3 -27
  69. data/lib/google/cloud/dataplex/v1/metadata_pb.rb +3 -25
  70. data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +2 -0
  71. data/lib/google/cloud/dataplex/v1/metadata_service/credentials.rb +2 -1
  72. data/lib/google/cloud/dataplex/v1/metadata_service/rest/client.rb +2 -0
  73. data/lib/google/cloud/dataplex/v1/processing_pb.rb +5 -24
  74. data/lib/google/cloud/dataplex/v1/resources_pb.rb +2 -25
  75. data/lib/google/cloud/dataplex/v1/rest.rb +1 -1
  76. data/lib/google/cloud/dataplex/v1/security_pb.rb +2 -23
  77. data/lib/google/cloud/dataplex/v1/service_pb.rb +3 -38
  78. data/lib/google/cloud/dataplex/v1/service_services_pb.rb +0 -13
  79. data/lib/google/cloud/dataplex/v1/tasks_pb.rb +2 -25
  80. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  81. data/lib/google/cloud/dataplex/v1.rb +1 -0
  82. data/proto_docs/google/api/client.rb +149 -29
  83. data/proto_docs/google/cloud/dataplex/v1/approval_workflow.rb +263 -0
  84. data/proto_docs/google/cloud/dataplex/v1/catalog.rb +427 -3
  85. data/proto_docs/google/cloud/dataplex/v1/data_discovery.rb +13 -0
  86. data/proto_docs/google/cloud/dataplex/v1/data_documentation.rb +118 -2
  87. data/proto_docs/google/cloud/dataplex/v1/data_products.rb +567 -0
  88. data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +21 -0
  89. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +240 -10
  90. data/proto_docs/google/cloud/dataplex/v1/data_quality_rule_template.rb +88 -0
  91. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +82 -5
  92. data/proto_docs/google/cloud/dataplex/v1/datascans_common.rb +7 -3
  93. data/proto_docs/google/cloud/dataplex/v1/logs.rb +7 -0
  94. data/proto_docs/google/cloud/dataplex/v1/processing.rb +27 -3
  95. data/proto_docs/google/cloud/dataplex/v1/service.rb +0 -148
  96. metadata +20 -12
  97. data/lib/google/cloud/dataplex/v1/content_service/client.rb +0 -1261
  98. data/lib/google/cloud/dataplex/v1/content_service/paths.rb +0 -73
  99. data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +0 -1171
  100. data/proto_docs/google/cloud/dataplex/v1/content.rb +0 -142
@@ -359,7 +359,7 @@ module Google
359
359
  end
360
360
  end
361
361
 
362
- # An aspect is a single piece of metadata describing an entry.
362
+ # Represents a single piece of metadata describing an entry or entry link.
363
363
  # @!attribute [r] aspect_type
364
364
  # @return [::String]
365
365
  # Output only. The resource name of the type used to create this Aspect.
@@ -1025,6 +1025,9 @@ module Google
1025
1025
  # @return [::Google::Cloud::Dataplex::V1::EntryView]
1026
1026
  # Optional. View to control which parts of an entry the service should
1027
1027
  # return.
1028
+ # **Please check the limitations on returned aspects in the Entry view
1029
+ # documentation. Amount of returned aspects depends on the selected Entry
1030
+ # View.**
1028
1031
  # @!attribute [rw] aspect_types
1029
1032
  # @return [::Array<::String>]
1030
1033
  # Optional. Limits the aspects returned to the provided aspect types.
@@ -1047,6 +1050,9 @@ module Google
1047
1050
  # @return [::Google::Cloud::Dataplex::V1::EntryView]
1048
1051
  # Optional. View to control which parts of an entry the service should
1049
1052
  # return.
1053
+ # **Please check the limitations on returned aspects in the Entry view
1054
+ # documentation. Amount of returned aspects depends on the selected Entry
1055
+ # View.**
1050
1056
  # @!attribute [rw] aspect_types
1051
1057
  # @return [::Array<::String>]
1052
1058
  # Optional. Limits the aspects returned to the provided aspect types.
@@ -1064,6 +1070,102 @@ module Google
1064
1070
  extend ::Google::Protobuf::MessageExts::ClassMethods
1065
1071
  end
1066
1072
 
1073
+ # Lookup Context using permissions in the source system.
1074
+ # @!attribute [rw] name
1075
+ # @return [::String]
1076
+ # Required. The project to which the request should be attributed in the
1077
+ # following form: `projects/{project}/locations/{location}`.
1078
+ # @!attribute [rw] resources
1079
+ # @return [::Array<::String>]
1080
+ # Required. The entry names to look up the context for. The maximum number of
1081
+ # resources for a request is limited to 10.
1082
+ #
1083
+ # ## Examples:
1084
+ #
1085
+ # `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`
1086
+ # @!attribute [rw] context
1087
+ # @return [::String]
1088
+ # Optional. The text representing contextual information for which metadata
1089
+ # context is being requested.
1090
+ # @!attribute [rw] options
1091
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1092
+ # Optional. Allows to configure the context.
1093
+ #
1094
+ # Supported options:
1095
+ #
1096
+ # - `format` - The format of the context (one of `yaml`,
1097
+ # `xml`, `json`, default is `yaml`).
1098
+ # - `context_budget` - If provided, the output will be intelligently
1099
+ # truncated on a best-effort basis to contain approximately the desired
1100
+ # amount of characters. There is no guarantee to achieve the specific amount.
1101
+ class LookupContextRequest
1102
+ include ::Google::Protobuf::MessageExts
1103
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1104
+
1105
+ # @!attribute [rw] key
1106
+ # @return [::String]
1107
+ # @!attribute [rw] value
1108
+ # @return [::String]
1109
+ class OptionsEntry
1110
+ include ::Google::Protobuf::MessageExts
1111
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1112
+ end
1113
+ end
1114
+
1115
+ # Modify Entry request using permissions in the source system.
1116
+ # @!attribute [rw] name
1117
+ # @return [::String]
1118
+ # Required. The project to which the request should be attributed in the
1119
+ # following form: `projects/{project}/locations/{location}`.
1120
+ # @!attribute [rw] entry
1121
+ # @return [::Google::Cloud::Dataplex::V1::Entry]
1122
+ # Required. The entry to modify.
1123
+ # @!attribute [rw] update_mask
1124
+ # @return [::Google::Protobuf::FieldMask]
1125
+ # Optional. Mask of fields to update. To update Aspects, the update_mask must
1126
+ # contain the value "aspects".
1127
+ #
1128
+ # If the update_mask is empty, the service will update all modifiable fields
1129
+ # present in the request.
1130
+ # @!attribute [rw] delete_missing_aspects
1131
+ # @return [::Boolean]
1132
+ # Optional. If set to true, any aspects not specified in the request will be
1133
+ # deleted. The default is false.
1134
+ # @!attribute [rw] aspect_keys
1135
+ # @return [::Array<::String>]
1136
+ # Optional. The aspect keys which the service should modify. It supports
1137
+ # the following syntaxes:
1138
+ #
1139
+ # * `<aspect_type_reference>` - matches an aspect of the given type and empty
1140
+ # path.
1141
+ # * `<aspect_type_reference>@path` - matches an aspect of the given type and
1142
+ # specified path. For example, to attach an aspect to a field that is
1143
+ # specified by the `schema` aspect, the path should have the format
1144
+ # `Schema.<field_name>`.
1145
+ # * `<aspect_type_reference>@*` - matches aspects of the given type for all
1146
+ # paths.
1147
+ # * `*@path` - matches aspects of all types on the given path.
1148
+ #
1149
+ # The service will not remove existing aspects matching the syntax unless
1150
+ # `delete_missing_aspects` is set to true.
1151
+ #
1152
+ # If this field is left empty, the service treats it as specifying
1153
+ # exactly those Aspects present in the request.
1154
+ class ModifyEntryRequest
1155
+ include ::Google::Protobuf::MessageExts
1156
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1157
+ end
1158
+
1159
+ # Lookup Context response.
1160
+ # @!attribute [rw] context
1161
+ # @return [::String]
1162
+ # Pre-formatted block of text containing the context for the requested
1163
+ # resources.
1164
+ class LookupContextResponse
1165
+ include ::Google::Protobuf::MessageExts
1166
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1167
+ end
1168
+
1067
1169
  # @!attribute [rw] name
1068
1170
  # @return [::String]
1069
1171
  # Required. The project to which the request should be attributed in the
@@ -1769,10 +1871,16 @@ module Google
1769
1871
  # @!attribute [r] update_time
1770
1872
  # @return [::Google::Protobuf::Timestamp]
1771
1873
  # Output only. The time when the Entry Link was last updated.
1874
+ # @!attribute [rw] aspects
1875
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dataplex::V1::Aspect}]
1876
+ # Optional. The aspects that are attached to the entry link.
1877
+ # The format of the aspect key has to be the following:
1878
+ # `{project_id_or_number}.{location_id}.{aspect_type_id}`
1879
+ # Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
1772
1880
  # @!attribute [rw] entry_references
1773
1881
  # @return [::Array<::Google::Cloud::Dataplex::V1::EntryLink::EntryReference>]
1774
- # Required. Specifies the Entries referenced in the Entry Link. There should
1775
- # be exactly two entry references.
1882
+ # Required. Immutable. Specifies the Entries referenced in the Entry Link.
1883
+ # There should be exactly two entry references.
1776
1884
  class EntryLink
1777
1885
  include ::Google::Protobuf::MessageExts
1778
1886
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1808,6 +1916,15 @@ module Google
1808
1916
  TARGET = 3
1809
1917
  end
1810
1918
  end
1919
+
1920
+ # @!attribute [rw] key
1921
+ # @return [::String]
1922
+ # @!attribute [rw] value
1923
+ # @return [::Google::Cloud::Dataplex::V1::Aspect]
1924
+ class AspectsEntry
1925
+ include ::Google::Protobuf::MessageExts
1926
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1927
+ end
1811
1928
  end
1812
1929
 
1813
1930
  # Request message for CreateEntryLink.
@@ -1831,6 +1948,27 @@ module Google
1831
1948
  extend ::Google::Protobuf::MessageExts::ClassMethods
1832
1949
  end
1833
1950
 
1951
+ # Request message for UpdateEntryLink method.
1952
+ # @!attribute [rw] entry_link
1953
+ # @return [::Google::Cloud::Dataplex::V1::EntryLink]
1954
+ # Required. Entry Link resource.
1955
+ # @!attribute [rw] allow_missing
1956
+ # @return [::Boolean]
1957
+ # Optional. If set to true and the entry link doesn't exist, the service will
1958
+ # create it.
1959
+ # @!attribute [rw] aspect_keys
1960
+ # @return [::Array<::String>]
1961
+ # Optional. The map keys of the Aspects which the service should modify.
1962
+ # It should be the aspect type reference in the format
1963
+ # `{project_id_or_number}.{location_id}.{aspect_type_id}`.
1964
+ #
1965
+ # If this field is left empty, the service treats it as specifying
1966
+ # exactly those Aspects present in the request.
1967
+ class UpdateEntryLinkRequest
1968
+ include ::Google::Protobuf::MessageExts
1969
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1970
+ end
1971
+
1834
1972
  # Request message for DeleteEntryLink.
1835
1973
  # @!attribute [rw] name
1836
1974
  # @return [::String]
@@ -1841,6 +1979,66 @@ module Google
1841
1979
  extend ::Google::Protobuf::MessageExts::ClassMethods
1842
1980
  end
1843
1981
 
1982
+ # Request message for LookupEntryLinks.
1983
+ # @!attribute [rw] name
1984
+ # @return [::String]
1985
+ # Required. The project to which the request should be attributed to
1986
+ # Format: `projects/{project_id_or_number}/locations/{location_id}`.
1987
+ # @!attribute [rw] entry
1988
+ # @return [::String]
1989
+ # Required. The resource name of the referred Entry.
1990
+ # Format:
1991
+ # `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`.
1992
+ # Entry Links which references this entry will be returned in the response.
1993
+ # @!attribute [rw] entry_mode
1994
+ # @return [::Google::Cloud::Dataplex::V1::LookupEntryLinksRequest::EntryMode]
1995
+ # Mode of entry reference.
1996
+ # @!attribute [rw] entry_link_types
1997
+ # @return [::Array<::String>]
1998
+ # Entry link types to filter the response by. If empty, all entry link types
1999
+ # will be returned. At most 10 entry link types can be specified.
2000
+ # @!attribute [rw] page_size
2001
+ # @return [::Integer]
2002
+ # Maximum number of EntryLinks to return. The service may return fewer
2003
+ # than this value. If unspecified, at most 10 EntryLinks will be returned.
2004
+ # The maximum value is 10; values above 10 will be coerced to 10.
2005
+ # @!attribute [rw] page_token
2006
+ # @return [::String]
2007
+ # Page token received from a previous `LookupEntryLinks` call. Provide this
2008
+ # to retrieve the subsequent page. When paginating, all other parameters that
2009
+ # are provided to the `LookupEntryLinks` request must match the call that
2010
+ # provided the page token.
2011
+ class LookupEntryLinksRequest
2012
+ include ::Google::Protobuf::MessageExts
2013
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2014
+
2015
+ # Mode of entry reference.
2016
+ module EntryMode
2017
+ # Unspecified entry mode. Returns both directional and non-directional
2018
+ # entry links which references the entry.
2019
+ ENTRY_MODE_UNSPECIFIED = 0
2020
+
2021
+ # Returns all directed entry links which references the entry as source.
2022
+ SOURCE = 1
2023
+
2024
+ # Return all directed entry links which references the entry as target.
2025
+ TARGET = 2
2026
+ end
2027
+ end
2028
+
2029
+ # Response message for LookupEntryLinks.
2030
+ # @!attribute [rw] entry_links
2031
+ # @return [::Array<::Google::Cloud::Dataplex::V1::EntryLink>]
2032
+ # List of entry links that reference the specified entry.
2033
+ # @!attribute [rw] next_page_token
2034
+ # @return [::String]
2035
+ # Token to retrieve the next page of results, or empty if there are no more
2036
+ # results in the list.
2037
+ class LookupEntryLinksResponse
2038
+ include ::Google::Protobuf::MessageExts
2039
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2040
+ end
2041
+
1844
2042
  # Request message for GetEntryLink.
1845
2043
  # @!attribute [rw] name
1846
2044
  # @return [::String]
@@ -1851,6 +2049,230 @@ module Google
1851
2049
  extend ::Google::Protobuf::MessageExts::ClassMethods
1852
2050
  end
1853
2051
 
2052
+ # MetadataFeed contains information related to the metadata feed.
2053
+ # @!attribute [rw] name
2054
+ # @return [::String]
2055
+ # Identifier. The resource name of the metadata feed, in the format
2056
+ # `projects/{project_id_or_number}/locations/{location_id}/metadataFeeds/{metadata_feed_id}`.
2057
+ # @!attribute [r] uid
2058
+ # @return [::String]
2059
+ # Output only. A system-generated, globally unique ID for the metadata job.
2060
+ # If the metadata job is deleted and then re-created with the same name, this
2061
+ # ID is different.
2062
+ # @!attribute [rw] scope
2063
+ # @return [::Google::Cloud::Dataplex::V1::MetadataFeed::Scope]
2064
+ # Required. The scope of the metadata feed.
2065
+ # Only the in scope changes are published.
2066
+ # @!attribute [rw] filters
2067
+ # @return [::Google::Cloud::Dataplex::V1::MetadataFeed::Filters]
2068
+ # Optional. The filters of the metadata feed.
2069
+ # Only the changes that match the filters are published.
2070
+ # @!attribute [r] create_time
2071
+ # @return [::Google::Protobuf::Timestamp]
2072
+ # Output only. The time when the feed was created.
2073
+ # @!attribute [r] update_time
2074
+ # @return [::Google::Protobuf::Timestamp]
2075
+ # Output only. The time when the feed was updated.
2076
+ # @!attribute [rw] labels
2077
+ # @return [::Google::Protobuf::Map{::String => ::String}]
2078
+ # Optional. User-defined labels.
2079
+ # @!attribute [rw] pubsub_topic
2080
+ # @return [::String]
2081
+ # Optional. The pubsub topic that you want the metadata feed messages to
2082
+ # publish to. Please grant Dataplex service account the permission to
2083
+ # publish messages to the topic. The service account is:
2084
+ # service-\\{PROJECT_NUMBER}@gcp-sa-dataplex.iam.gserviceaccount.com.
2085
+ class MetadataFeed
2086
+ include ::Google::Protobuf::MessageExts
2087
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2088
+
2089
+ # Scope defines the scope of the metadata feed.
2090
+ # Scopes are exclusive. Only one of the scopes can be specified.
2091
+ # @!attribute [rw] organization_level
2092
+ # @return [::Boolean]
2093
+ # Optional. Whether the metadata feed is at the organization-level.
2094
+ #
2095
+ # - If `true`, all changes happened to the entries in the same
2096
+ # organization as the feed are published.
2097
+ # - If `false`, you must specify a list of projects or a list of entry
2098
+ # groups whose entries you want to listen to.
2099
+ #
2100
+ # The default is `false`.
2101
+ # @!attribute [rw] projects
2102
+ # @return [::Array<::String>]
2103
+ # Optional. The projects whose entries you want to listen to.
2104
+ # Must be in the same organization as the feed.
2105
+ # Must be in the format: `projects/{project_id_or_number}`.
2106
+ # @!attribute [rw] entry_groups
2107
+ # @return [::Array<::String>]
2108
+ # Optional. The entry groups whose entries you want to listen to.
2109
+ # Must be in the format:
2110
+ # `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
2111
+ class Scope
2112
+ include ::Google::Protobuf::MessageExts
2113
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2114
+ end
2115
+
2116
+ # Filters defines the type of changes that you want to listen to.
2117
+ # You can have multiple entry type filters and multiple aspect type filters.
2118
+ # All of the entry type filters are OR'ed together.
2119
+ # All of the aspect type filters are OR'ed together.
2120
+ # All of the entry type filters and aspect type filters are AND'ed together.
2121
+ # @!attribute [rw] entry_types
2122
+ # @return [::Array<::String>]
2123
+ # Optional. The entry types that you want to listen to, specified as
2124
+ # relative resource names in the format
2125
+ # `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
2126
+ # Only entries that belong to the specified entry types are published.
2127
+ # @!attribute [rw] aspect_types
2128
+ # @return [::Array<::String>]
2129
+ # Optional. The aspect types that you want to listen to. Depending on how
2130
+ # the aspect is attached to the entry, in the format:
2131
+ # `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
2132
+ # @!attribute [rw] change_types
2133
+ # @return [::Array<::Google::Cloud::Dataplex::V1::MetadataFeed::Filters::ChangeType>]
2134
+ # Optional. The type of change that you want to listen to.
2135
+ # If not specified, all changes are published.
2136
+ class Filters
2137
+ include ::Google::Protobuf::MessageExts
2138
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2139
+
2140
+ # The type of change that you want to listen to.
2141
+ module ChangeType
2142
+ # Unspecified change type. Defaults to UNSPECIFIED.
2143
+ CHANGE_TYPE_UNSPECIFIED = 0
2144
+
2145
+ # The change is a create event.
2146
+ CREATE = 1
2147
+
2148
+ # The change is an update event.
2149
+ UPDATE = 2
2150
+
2151
+ # The change is a delete event.
2152
+ DELETE = 3
2153
+ end
2154
+ end
2155
+
2156
+ # @!attribute [rw] key
2157
+ # @return [::String]
2158
+ # @!attribute [rw] value
2159
+ # @return [::String]
2160
+ class LabelsEntry
2161
+ include ::Google::Protobuf::MessageExts
2162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2163
+ end
2164
+ end
2165
+
2166
+ # Request message for CreateMetadataFeed.
2167
+ # @!attribute [rw] parent
2168
+ # @return [::String]
2169
+ # Required. The resource name of the parent location, in the format
2170
+ # `projects/{project_id_or_number}/locations/{location_id}`
2171
+ # @!attribute [rw] metadata_feed
2172
+ # @return [::Google::Cloud::Dataplex::V1::MetadataFeed]
2173
+ # Required. The metadata job resource.
2174
+ # @!attribute [rw] metadata_feed_id
2175
+ # @return [::String]
2176
+ # Optional. The metadata job ID. If not provided, a unique ID is generated
2177
+ # with the prefix `metadata-job-`.
2178
+ # @!attribute [rw] validate_only
2179
+ # @return [::Boolean]
2180
+ # Optional. The service validates the request without performing any
2181
+ # mutations. The default is false.
2182
+ class CreateMetadataFeedRequest
2183
+ include ::Google::Protobuf::MessageExts
2184
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2185
+ end
2186
+
2187
+ # Request message for GetMetadataFeed.
2188
+ # @!attribute [rw] name
2189
+ # @return [::String]
2190
+ # Required. The resource name of the metadata feed, in the format
2191
+ # `projects/{project_id_or_number}/locations/{location_id}/MetadataFeeds/{metadata_feed_id}`.
2192
+ class GetMetadataFeedRequest
2193
+ include ::Google::Protobuf::MessageExts
2194
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2195
+ end
2196
+
2197
+ # Request message for ListMetadataFeedsRequest.
2198
+ # @!attribute [rw] parent
2199
+ # @return [::String]
2200
+ # Required. The resource name of the parent location, in the format
2201
+ # `projects/{project_id_or_number}/locations/{location_id}`
2202
+ # @!attribute [rw] page_size
2203
+ # @return [::Integer]
2204
+ # Optional. The maximum number of metadata feeds to return. The service
2205
+ # might return fewer feeds than this value. If unspecified, at most 10 feeds
2206
+ # are returned. The maximum value is 1,000.
2207
+ # @!attribute [rw] page_token
2208
+ # @return [::String]
2209
+ # Optional. The page token received from a previous `ListMetadataFeeds` call.
2210
+ # Provide this token to retrieve the subsequent page of results. When
2211
+ # paginating, all other parameters that are provided to the
2212
+ # `ListMetadataFeeds` request must match the call that provided the
2213
+ # page token.
2214
+ # @!attribute [rw] filter
2215
+ # @return [::String]
2216
+ # Optional. Filter request. Filters are case-sensitive.
2217
+ # The service supports the following formats:
2218
+ #
2219
+ # * `labels.key1 = "value1"`
2220
+ # * `labels:key1`
2221
+ # * `name = "value"`
2222
+ #
2223
+ # You can combine filters with `AND`, `OR`, and `NOT` operators.
2224
+ # @!attribute [rw] order_by
2225
+ # @return [::String]
2226
+ # Optional. The field to sort the results by, either `name` or `create_time`.
2227
+ # If not specified, the ordering is undefined.
2228
+ class ListMetadataFeedsRequest
2229
+ include ::Google::Protobuf::MessageExts
2230
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2231
+ end
2232
+
2233
+ # Response message for ListMetadataFeeds.
2234
+ # @!attribute [rw] metadata_feeds
2235
+ # @return [::Array<::Google::Cloud::Dataplex::V1::MetadataFeed>]
2236
+ # List of metadata feeds under the specified parent location.
2237
+ # @!attribute [rw] next_page_token
2238
+ # @return [::String]
2239
+ # A token to retrieve the next page of results. If there are no more results
2240
+ # in the list, the value is empty.
2241
+ # @!attribute [rw] unreachable
2242
+ # @return [::Array<::String>]
2243
+ # Unordered list. Locations that the service couldn't reach.
2244
+ class ListMetadataFeedsResponse
2245
+ include ::Google::Protobuf::MessageExts
2246
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2247
+ end
2248
+
2249
+ # Request message for DeleteMetadataFeed.
2250
+ # @!attribute [rw] name
2251
+ # @return [::String]
2252
+ # Required. The resource name of the metadata feed, in the format
2253
+ # `projects/{project_id_or_number}/locations/{location_id}/MetadataFeeds/{metadata_feed_id}`.
2254
+ class DeleteMetadataFeedRequest
2255
+ include ::Google::Protobuf::MessageExts
2256
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2257
+ end
2258
+
2259
+ # Request message for UpdateMetadataFeed.
2260
+ # @!attribute [rw] metadata_feed
2261
+ # @return [::Google::Cloud::Dataplex::V1::MetadataFeed]
2262
+ # Required. Update description.
2263
+ # Only fields specified in `update_mask` are updated.
2264
+ # @!attribute [rw] update_mask
2265
+ # @return [::Google::Protobuf::FieldMask]
2266
+ # Optional. Mask of fields to update.
2267
+ # @!attribute [rw] validate_only
2268
+ # @return [::Boolean]
2269
+ # Optional. Only validate the request, but do not perform mutations.
2270
+ # The default is false.
2271
+ class UpdateMetadataFeedRequest
2272
+ include ::Google::Protobuf::MessageExts
2273
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2274
+ end
2275
+
1854
2276
  # View for controlling which parts of an entry are to be returned.
1855
2277
  module EntryView
1856
2278
  # Unspecified EntryView. Defaults to FULL.
@@ -1867,6 +2289,8 @@ module Google
1867
2289
  # aspects exceeds 100, the first 100 will be returned.
1868
2290
  CUSTOM = 3
1869
2291
 
2292
+ # Returns all aspects. If the number of aspects exceeds 100, the first
2293
+ # 100 will be returned.
1870
2294
  ALL = 4
1871
2295
  end
1872
2296
 
@@ -114,6 +114,9 @@ module Google
114
114
  # @!attribute [rw] json_options
115
115
  # @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec::StorageConfig::JsonOptions]
116
116
  # Optional. Configuration for JSON data.
117
+ # @!attribute [rw] unstructured_data_options
118
+ # @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec::StorageConfig::UnstructuredDataOptions]
119
+ # Optional. Specifies configuration for unstructured data discovery.
117
120
  class StorageConfig
118
121
  include ::Google::Protobuf::MessageExts
119
122
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -157,6 +160,16 @@ module Google
157
160
  include ::Google::Protobuf::MessageExts
158
161
  extend ::Google::Protobuf::MessageExts::ClassMethods
159
162
  end
163
+
164
+ # Describes options for unstructured data discovery.
165
+ # @!attribute [rw] semantic_inference_enabled
166
+ # @return [::Boolean]
167
+ # Optional. Specifies whether deeper semantic inference over the objects'
168
+ # contents using GenAI is enabled.
169
+ class UnstructuredDataOptions
170
+ include ::Google::Protobuf::MessageExts
171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
172
+ end
160
173
  end
161
174
  end
162
175
 
@@ -22,20 +22,69 @@ module Google
22
22
  module Dataplex
23
23
  module V1
24
24
  # DataDocumentation scan related spec.
25
+ # @!attribute [rw] catalog_publishing_enabled
26
+ # @return [::Boolean]
27
+ # Optional. Whether to publish result to Dataplex Catalog.
28
+ # @!attribute [rw] generation_scopes
29
+ # @return [::Array<::Google::Cloud::Dataplex::V1::DataDocumentationSpec::GenerationScope>]
30
+ # Optional. Specifies which components of the data documentation to generate.
31
+ # Any component that is required to generate the specified components will
32
+ # also be generated. If no generation scope is specified, all available
33
+ # documentation components will be generated.
25
34
  class DataDocumentationSpec
26
35
  include ::Google::Protobuf::MessageExts
27
36
  extend ::Google::Protobuf::MessageExts::ClassMethods
37
+
38
+ # The data documentation generation scope. This field contains the possible
39
+ # components of a data documentation scan which can be selectively generated.
40
+ module GenerationScope
41
+ # Unspecified generation scope. If no generation scope is specified, all
42
+ # available documentation components will be generated.
43
+ GENERATION_SCOPE_UNSPECIFIED = 0
44
+
45
+ # All the possible results will be generated.
46
+ ALL = 1
47
+
48
+ # Table and column descriptions will be generated.
49
+ TABLE_AND_COLUMN_DESCRIPTIONS = 2
50
+
51
+ # SQL queries will be generated.
52
+ SQL_QUERIES = 3
53
+ end
28
54
  end
29
55
 
30
56
  # The output of a DataDocumentation scan.
57
+ # @!attribute [r] dataset_result
58
+ # @return [::Google::Cloud::Dataplex::V1::DataDocumentationResult::DatasetResult]
59
+ # Output only. Insights for a Dataset resource.
60
+ #
61
+ # Note: The following fields are mutually exclusive: `dataset_result`, `table_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
31
62
  # @!attribute [r] table_result
32
63
  # @return [::Google::Cloud::Dataplex::V1::DataDocumentationResult::TableResult]
33
- # Output only. Table result for insights.
64
+ # Output only. Insights for a Table resource.
65
+ #
66
+ # Note: The following fields are mutually exclusive: `table_result`, `dataset_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
34
67
  class DataDocumentationResult
35
68
  include ::Google::Protobuf::MessageExts
36
69
  extend ::Google::Protobuf::MessageExts::ClassMethods
37
70
 
38
- # Generated metadata about the table.
71
+ # Insights for a dataset resource.
72
+ # @!attribute [r] overview
73
+ # @return [::String]
74
+ # Output only. Generated Dataset description.
75
+ # @!attribute [r] schema_relationships
76
+ # @return [::Array<::Google::Cloud::Dataplex::V1::DataDocumentationResult::SchemaRelationship>]
77
+ # Output only. Relationships suggesting how tables in the dataset are
78
+ # related to each other, based on their schema.
79
+ # @!attribute [r] queries
80
+ # @return [::Array<::Google::Cloud::Dataplex::V1::DataDocumentationResult::Query>]
81
+ # Output only. Sample SQL queries for the dataset.
82
+ class DatasetResult
83
+ include ::Google::Protobuf::MessageExts
84
+ extend ::Google::Protobuf::MessageExts::ClassMethods
85
+ end
86
+
87
+ # Insights for a table resource.
39
88
  # @!attribute [r] name
40
89
  # @return [::String]
41
90
  # Output only. The service-qualified full resource name of the cloud
@@ -56,6 +105,73 @@ module Google
56
105
  extend ::Google::Protobuf::MessageExts::ClassMethods
57
106
  end
58
107
 
108
+ # Details of the relationship between the schema of two resources.
109
+ # @!attribute [r] left_schema_paths
110
+ # @return [::Google::Cloud::Dataplex::V1::DataDocumentationResult::SchemaRelationship::SchemaPaths]
111
+ # Output only. An ordered list of fields for the join from the first table.
112
+ # The size of this list must be the same as `right_schema_paths`.
113
+ # Each field at index i in this list must correspond to a field at the same
114
+ # index in the `right_schema_paths` list.
115
+ # @!attribute [r] right_schema_paths
116
+ # @return [::Google::Cloud::Dataplex::V1::DataDocumentationResult::SchemaRelationship::SchemaPaths]
117
+ # Output only. An ordered list of fields for the join from the second
118
+ # table. The size of this list must be the same as `left_schema_paths`.
119
+ # Each field at index i in this list must correspond to a field at the same
120
+ # index in the `left_schema_paths` list.
121
+ # @!attribute [r] sources
122
+ # @return [::Array<::Google::Cloud::Dataplex::V1::DataDocumentationResult::SchemaRelationship::Source>]
123
+ # Output only. Sources which generated the schema relation edge.
124
+ # @!attribute [r] type
125
+ # @return [::Google::Cloud::Dataplex::V1::DataDocumentationResult::SchemaRelationship::Type]
126
+ # Output only. The type of relationship between the schema paths.
127
+ class SchemaRelationship
128
+ include ::Google::Protobuf::MessageExts
129
+ extend ::Google::Protobuf::MessageExts::ClassMethods
130
+
131
+ # Represents an ordered set of paths within a table's schema.
132
+ # @!attribute [r] table_fqn
133
+ # @return [::String]
134
+ # Output only. The service-qualified full resource name of the table
135
+ # Ex:
136
+ # //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
137
+ # @!attribute [r] paths
138
+ # @return [::Array<::String>]
139
+ # Output only. An ordered set of Paths to fields within the schema of the
140
+ # table. For fields nested within a top level field of type record, use
141
+ # '.' to separate field names. Examples: Top level field - `top_level`
142
+ # Nested field - `top_level.child.sub_field`
143
+ class SchemaPaths
144
+ include ::Google::Protobuf::MessageExts
145
+ extend ::Google::Protobuf::MessageExts::ClassMethods
146
+ end
147
+
148
+ # Source which generated the schema relation edge.
149
+ module Source
150
+ # The source of the schema relationship is unspecified.
151
+ SOURCE_UNSPECIFIED = 0
152
+
153
+ # The source of the schema relationship is agent.
154
+ AGENT = 4
155
+
156
+ # The source of the schema relationship is query history from the source
157
+ # system.
158
+ QUERY_HISTORY = 5
159
+
160
+ # The source of the schema relationship is table constraints added in
161
+ # the source system.
162
+ TABLE_CONSTRAINTS = 6
163
+ end
164
+
165
+ # The type of relationship.
166
+ module Type
167
+ # The type of the schema relationship is unspecified.
168
+ TYPE_UNSPECIFIED = 0
169
+
170
+ # Indicates a join relationship between the schema fields.
171
+ SCHEMA_JOIN = 1
172
+ end
173
+ end
174
+
59
175
  # A sample SQL query in data documentation.
60
176
  # @!attribute [r] sql
61
177
  # @return [::String]