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.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/dataplex/v1/analyze_pb.rb +2 -25
- data/lib/google/cloud/dataplex/v1/approval_workflow_pb.rb +33 -0
- data/lib/google/cloud/dataplex/v1/bindings_override.rb +24 -24
- data/lib/google/cloud/dataplex/v1/business_glossary_pb.rb +3 -26
- data/lib/google/cloud/dataplex/v1/business_glossary_service/client.rb +2 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/credentials.rb +4 -1
- data/lib/google/cloud/dataplex/v1/business_glossary_service/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/client.rb +2 -0
- data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/catalog_pb.rb +20 -27
- data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +1074 -73
- data/lib/google/cloud/dataplex/v1/catalog_service/credentials.rb +4 -1
- data/lib/google/cloud/dataplex/v1/catalog_service/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +19 -0
- data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +1020 -82
- data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +554 -0
- data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +18 -15
- data/lib/google/cloud/dataplex/v1/cmek_pb.rb +3 -26
- data/lib/google/cloud/dataplex/v1/cmek_service/client.rb +2 -0
- data/lib/google/cloud/dataplex/v1/cmek_service/credentials.rb +2 -1
- data/lib/google/cloud/dataplex/v1/cmek_service/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/cmek_service/rest/client.rb +2 -0
- data/lib/google/cloud/dataplex/v1/cmek_service/rest/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/content_pb.rb +3 -38
- data/lib/google/cloud/dataplex/v1/content_services_pb.rb +0 -49
- data/lib/google/cloud/dataplex/v1/data_discovery_pb.rb +4 -24
- data/lib/google/cloud/dataplex/v1/data_documentation_pb.rb +10 -24
- data/lib/google/cloud/dataplex/v1/data_product_service/client.rb +1644 -0
- data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/credentials.rb +7 -4
- data/lib/google/cloud/dataplex/v1/data_product_service/operations.rb +843 -0
- data/lib/google/cloud/dataplex/v1/data_product_service/paths.rb +231 -0
- data/lib/google/cloud/dataplex/v1/data_product_service/rest/client.rb +1533 -0
- data/lib/google/cloud/dataplex/v1/data_product_service/rest/operations.rb +956 -0
- data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/rest/service_stub.rb +284 -160
- data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/rest.rb +11 -10
- data/lib/google/cloud/dataplex/v1/{content_service.rb → data_product_service.rb} +15 -14
- data/lib/google/cloud/dataplex/v1/data_products_pb.rb +52 -0
- data/lib/google/cloud/dataplex/v1/data_products_services_pb.rb +69 -0
- data/lib/google/cloud/dataplex/v1/data_profile_pb.rb +4 -26
- data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +13 -26
- data/lib/google/cloud/dataplex/v1/data_quality_rule_template_pb.rb +25 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +99 -1
- data/lib/google/cloud/dataplex/v1/data_scan_service/credentials.rb +4 -1
- data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +21 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +92 -1
- data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/rest/service_stub.rb +62 -0
- data/lib/google/cloud/dataplex/v1/data_taxonomy_pb.rb +3 -27
- data/lib/google/cloud/dataplex/v1/data_taxonomy_service/client.rb +2 -0
- data/lib/google/cloud/dataplex/v1/data_taxonomy_service/credentials.rb +2 -1
- data/lib/google/cloud/dataplex/v1/data_taxonomy_service/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/client.rb +2 -0
- data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +2 -664
- data/lib/google/cloud/dataplex/v1/dataplex_service/credentials.rb +4 -1
- data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/paths.rb +0 -21
- data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +2 -622
- data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +2 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service/rest/service_stub.rb +0 -368
- data/lib/google/cloud/dataplex/v1/datascans_common_pb.rb +3 -24
- data/lib/google/cloud/dataplex/v1/datascans_pb.rb +9 -31
- data/lib/google/cloud/dataplex/v1/datascans_services_pb.rb +2 -0
- data/lib/google/cloud/dataplex/v1/logs_pb.rb +3 -27
- data/lib/google/cloud/dataplex/v1/metadata_pb.rb +3 -25
- data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +2 -0
- data/lib/google/cloud/dataplex/v1/metadata_service/credentials.rb +2 -1
- data/lib/google/cloud/dataplex/v1/metadata_service/rest/client.rb +2 -0
- data/lib/google/cloud/dataplex/v1/processing_pb.rb +5 -24
- data/lib/google/cloud/dataplex/v1/resources_pb.rb +2 -25
- data/lib/google/cloud/dataplex/v1/rest.rb +1 -1
- data/lib/google/cloud/dataplex/v1/security_pb.rb +2 -23
- data/lib/google/cloud/dataplex/v1/service_pb.rb +3 -38
- data/lib/google/cloud/dataplex/v1/service_services_pb.rb +0 -13
- data/lib/google/cloud/dataplex/v1/tasks_pb.rb +2 -25
- data/lib/google/cloud/dataplex/v1/version.rb +1 -1
- data/lib/google/cloud/dataplex/v1.rb +1 -0
- data/proto_docs/google/api/client.rb +149 -29
- data/proto_docs/google/cloud/dataplex/v1/approval_workflow.rb +263 -0
- data/proto_docs/google/cloud/dataplex/v1/catalog.rb +427 -3
- data/proto_docs/google/cloud/dataplex/v1/data_discovery.rb +13 -0
- data/proto_docs/google/cloud/dataplex/v1/data_documentation.rb +118 -2
- data/proto_docs/google/cloud/dataplex/v1/data_products.rb +567 -0
- data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +21 -0
- data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +240 -10
- data/proto_docs/google/cloud/dataplex/v1/data_quality_rule_template.rb +88 -0
- data/proto_docs/google/cloud/dataplex/v1/datascans.rb +82 -5
- data/proto_docs/google/cloud/dataplex/v1/datascans_common.rb +7 -3
- data/proto_docs/google/cloud/dataplex/v1/logs.rb +7 -0
- data/proto_docs/google/cloud/dataplex/v1/processing.rb +27 -3
- data/proto_docs/google/cloud/dataplex/v1/service.rb +0 -148
- metadata +20 -12
- data/lib/google/cloud/dataplex/v1/content_service/client.rb +0 -1261
- data/lib/google/cloud/dataplex/v1/content_service/paths.rb +0 -73
- data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +0 -1171
- data/proto_docs/google/cloud/dataplex/v1/content.rb +0 -142
|
@@ -0,0 +1,567 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Cloud
|
|
22
|
+
module Dataplex
|
|
23
|
+
module V1
|
|
24
|
+
# A data product is a curated collection of data assets, packaged to address
|
|
25
|
+
# specific use cases. It's a way to manage and share data in a more organized,
|
|
26
|
+
# product-like manner.
|
|
27
|
+
# @!attribute [rw] name
|
|
28
|
+
# @return [::String]
|
|
29
|
+
# Identifier. Resource name of the data product.
|
|
30
|
+
# Format:
|
|
31
|
+
# `projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}`.
|
|
32
|
+
# @!attribute [r] uid
|
|
33
|
+
# @return [::String]
|
|
34
|
+
# Output only. System generated unique ID for the data product.
|
|
35
|
+
# This ID will be different if the data product is deleted and re-created
|
|
36
|
+
# with the same name.
|
|
37
|
+
# @!attribute [rw] display_name
|
|
38
|
+
# @return [::String]
|
|
39
|
+
# Required. User-friendly display name of the data product.
|
|
40
|
+
# @!attribute [r] create_time
|
|
41
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
42
|
+
# Output only. The time at which the data product was created.
|
|
43
|
+
# @!attribute [r] update_time
|
|
44
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
45
|
+
# Output only. The time at which the data product was last updated.
|
|
46
|
+
# @!attribute [rw] etag
|
|
47
|
+
# @return [::String]
|
|
48
|
+
# Optional. This checksum is computed by the server based on the value of
|
|
49
|
+
# other fields, and may be sent on update and delete requests to ensure the
|
|
50
|
+
# client has an up-to-date value before proceeding.
|
|
51
|
+
# @!attribute [rw] labels
|
|
52
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
53
|
+
# Optional. User-defined labels for the data product.
|
|
54
|
+
#
|
|
55
|
+
# Example:
|
|
56
|
+
# ```
|
|
57
|
+
# {
|
|
58
|
+
# "environment": "production",
|
|
59
|
+
# "billing": "marketing-department"
|
|
60
|
+
# }
|
|
61
|
+
# ```
|
|
62
|
+
# @!attribute [rw] description
|
|
63
|
+
# @return [::String]
|
|
64
|
+
# Optional. Description of the data product.
|
|
65
|
+
# @!attribute [rw] icon
|
|
66
|
+
# @return [::String]
|
|
67
|
+
# Optional. Base64 encoded image representing the data product. Max
|
|
68
|
+
# Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API
|
|
69
|
+
# only performs validation on size of the encoded data. Note: For byte
|
|
70
|
+
# fields, the content of the fields are base64-encoded (which increases the
|
|
71
|
+
# size of the data by 33-36%) when using JSON on the wire.
|
|
72
|
+
# @!attribute [rw] owner_emails
|
|
73
|
+
# @return [::Array<::String>]
|
|
74
|
+
# Required. Emails of the data product owners.
|
|
75
|
+
# @!attribute [r] asset_count
|
|
76
|
+
# @return [::Integer]
|
|
77
|
+
# Output only. Number of data assets associated with this data product.
|
|
78
|
+
# @!attribute [rw] access_groups
|
|
79
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dataplex::V1::DataProduct::AccessGroup}]
|
|
80
|
+
# Optional. Data product access groups by access group id as key.
|
|
81
|
+
# If data product is used only for packaging data assets, then access groups
|
|
82
|
+
# may be empty. However, if a data product is used for sharing data assets,
|
|
83
|
+
# then at least one access group must be specified.
|
|
84
|
+
#
|
|
85
|
+
# Example:
|
|
86
|
+
# ```
|
|
87
|
+
# {
|
|
88
|
+
# "analyst": {
|
|
89
|
+
# "id": "analyst",
|
|
90
|
+
# "displayName": "Analyst",
|
|
91
|
+
# "description": "Access group for analysts",
|
|
92
|
+
# "principal": {
|
|
93
|
+
# "googleGroup": "analysts@example.com"
|
|
94
|
+
# }
|
|
95
|
+
# }
|
|
96
|
+
# }
|
|
97
|
+
# ```
|
|
98
|
+
# @!attribute [rw] access_approval_config
|
|
99
|
+
# @return [::Google::Cloud::Dataplex::V1::DataProduct::AccessApprovalConfig]
|
|
100
|
+
# Optional. Configuration for access approval for the data product.
|
|
101
|
+
class DataProduct
|
|
102
|
+
include ::Google::Protobuf::MessageExts
|
|
103
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
104
|
+
|
|
105
|
+
# Represents the principal entity associated with an access group, as per
|
|
106
|
+
# https://cloud.google.com/iam/docs/principals-overview.
|
|
107
|
+
# @!attribute [rw] google_group
|
|
108
|
+
# @return [::String]
|
|
109
|
+
# Optional. Email of the Google Group, as per
|
|
110
|
+
# https://cloud.google.com/iam/docs/principals-overview#google-group.
|
|
111
|
+
# @!attribute [rw] service_account
|
|
112
|
+
# @return [::String]
|
|
113
|
+
# Optional. Specifies the email of the producer service account, as per
|
|
114
|
+
# https://cloud.google.com/iam/docs/principals-overview#service-account.
|
|
115
|
+
class Principal
|
|
116
|
+
include ::Google::Protobuf::MessageExts
|
|
117
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# Custom user defined access groups at the data product level. These are used
|
|
121
|
+
# for granting different levels of access (IAM roles) on the individual data
|
|
122
|
+
# product's data assets.
|
|
123
|
+
# @!attribute [rw] id
|
|
124
|
+
# @return [::String]
|
|
125
|
+
# Required. Unique identifier of the access group within the data product.
|
|
126
|
+
# User defined. Eg. "analyst", "developer", etc.
|
|
127
|
+
# @!attribute [rw] display_name
|
|
128
|
+
# @return [::String]
|
|
129
|
+
# Required. User friendly display name of the access group.
|
|
130
|
+
# Eg. "Analyst", "Developer", etc.
|
|
131
|
+
# @!attribute [rw] description
|
|
132
|
+
# @return [::String]
|
|
133
|
+
# Optional. Description of the access group.
|
|
134
|
+
# @!attribute [rw] principal
|
|
135
|
+
# @return [::Google::Cloud::Dataplex::V1::DataProduct::Principal]
|
|
136
|
+
# Required. The principal entity associated with this access group.
|
|
137
|
+
class AccessGroup
|
|
138
|
+
include ::Google::Protobuf::MessageExts
|
|
139
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
# Configuration for access approval for the data product.
|
|
143
|
+
# @!attribute [rw] approver_emails
|
|
144
|
+
# @return [::Array<::String>]
|
|
145
|
+
# Optional. Specifies the email addresses of users who are potential
|
|
146
|
+
# approvers and are notified when an access request is made for the data
|
|
147
|
+
# product. The maximum number of emails allowed is 10.
|
|
148
|
+
class AccessApprovalConfig
|
|
149
|
+
include ::Google::Protobuf::MessageExts
|
|
150
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# @!attribute [rw] key
|
|
154
|
+
# @return [::String]
|
|
155
|
+
# @!attribute [rw] value
|
|
156
|
+
# @return [::String]
|
|
157
|
+
class LabelsEntry
|
|
158
|
+
include ::Google::Protobuf::MessageExts
|
|
159
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
# @!attribute [rw] key
|
|
163
|
+
# @return [::String]
|
|
164
|
+
# @!attribute [rw] value
|
|
165
|
+
# @return [::Google::Cloud::Dataplex::V1::DataProduct::AccessGroup]
|
|
166
|
+
class AccessGroupsEntry
|
|
167
|
+
include ::Google::Protobuf::MessageExts
|
|
168
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
169
|
+
end
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
# Represents a data asset resource that can be packaged and shared via a data
|
|
173
|
+
# product.
|
|
174
|
+
# @!attribute [rw] name
|
|
175
|
+
# @return [::String]
|
|
176
|
+
# Identifier. Resource name of the data asset.
|
|
177
|
+
# Format:
|
|
178
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/dataProducts/\\{data_product_id}/dataAssets/\\{data_asset_id}
|
|
179
|
+
# @!attribute [r] uid
|
|
180
|
+
# @return [::String]
|
|
181
|
+
# Output only. System generated globally unique ID for the data asset.
|
|
182
|
+
# This ID will be different if the data asset is deleted and re-created
|
|
183
|
+
# with the same name.
|
|
184
|
+
# @!attribute [r] create_time
|
|
185
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
186
|
+
# Output only. The time at which the data asset was created.
|
|
187
|
+
# @!attribute [r] update_time
|
|
188
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
189
|
+
# Output only. The time at which the data asset was last updated.
|
|
190
|
+
# @!attribute [rw] etag
|
|
191
|
+
# @return [::String]
|
|
192
|
+
# Optional. This checksum is computed by the server based on the value of
|
|
193
|
+
# other fields, and may be sent on update and delete requests to ensure the
|
|
194
|
+
# client has an up-to-date value before proceeding.
|
|
195
|
+
# @!attribute [rw] labels
|
|
196
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
197
|
+
# Optional. User-defined labels for the data asset.
|
|
198
|
+
#
|
|
199
|
+
# Example:
|
|
200
|
+
# ```
|
|
201
|
+
# {
|
|
202
|
+
# "environment": "production",
|
|
203
|
+
# "billing": "marketing-department"
|
|
204
|
+
# }
|
|
205
|
+
# ```
|
|
206
|
+
# @!attribute [rw] resource
|
|
207
|
+
# @return [::String]
|
|
208
|
+
# Required. Immutable. Full resource name of the cloud resource represented
|
|
209
|
+
# by the data asset. This must follow
|
|
210
|
+
# https://cloud.google.com/iam/docs/full-resource-names. Example:
|
|
211
|
+
# `//bigquery.googleapis.com/projects/my_project_123/datasets/dataset_456/tables/table_789`
|
|
212
|
+
# Only BigQuery tables and datasets are currently supported.
|
|
213
|
+
# Data asset creator must have getIamPolicy and setIamPolicy permissions on
|
|
214
|
+
# the resource. Data asset creator must also have resource specific get
|
|
215
|
+
# permission, for instance, bigquery.tables.get for BigQuery tables.
|
|
216
|
+
# @!attribute [rw] access_group_configs
|
|
217
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dataplex::V1::DataAsset::AccessGroupConfig}]
|
|
218
|
+
# Optional. Access groups configurations for this data asset.
|
|
219
|
+
#
|
|
220
|
+
# The key is `DataProduct.AccessGroup.id` and the value is
|
|
221
|
+
# `AccessGroupConfig`.
|
|
222
|
+
#
|
|
223
|
+
# Example:
|
|
224
|
+
# ```
|
|
225
|
+
# {
|
|
226
|
+
# "analyst": {
|
|
227
|
+
# "iamRoles": ["roles/bigquery.dataViewer"]
|
|
228
|
+
# }
|
|
229
|
+
# }
|
|
230
|
+
# ```
|
|
231
|
+
#
|
|
232
|
+
# Currently, at most one IAM role is allowed per access group. For providing
|
|
233
|
+
# multiple predefined IAM roles, wrap them in a custom IAM role as per
|
|
234
|
+
# https://cloud.google.com/iam/docs/creating-custom-roles.
|
|
235
|
+
class DataAsset
|
|
236
|
+
include ::Google::Protobuf::MessageExts
|
|
237
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
238
|
+
|
|
239
|
+
# Configuration for access group inherited from the parent data product.
|
|
240
|
+
# @!attribute [rw] iam_roles
|
|
241
|
+
# @return [::Array<::String>]
|
|
242
|
+
# Optional. IAM roles granted on the resource to this access group. Role
|
|
243
|
+
# name follows https://cloud.google.com/iam/docs/reference/rest/v1/roles.
|
|
244
|
+
#
|
|
245
|
+
# Example: `[ "roles/bigquery.dataViewer" ]`
|
|
246
|
+
class AccessGroupConfig
|
|
247
|
+
include ::Google::Protobuf::MessageExts
|
|
248
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
249
|
+
end
|
|
250
|
+
|
|
251
|
+
# @!attribute [rw] key
|
|
252
|
+
# @return [::String]
|
|
253
|
+
# @!attribute [rw] value
|
|
254
|
+
# @return [::String]
|
|
255
|
+
class LabelsEntry
|
|
256
|
+
include ::Google::Protobuf::MessageExts
|
|
257
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
# @!attribute [rw] key
|
|
261
|
+
# @return [::String]
|
|
262
|
+
# @!attribute [rw] value
|
|
263
|
+
# @return [::Google::Cloud::Dataplex::V1::DataAsset::AccessGroupConfig]
|
|
264
|
+
class AccessGroupConfigsEntry
|
|
265
|
+
include ::Google::Protobuf::MessageExts
|
|
266
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
267
|
+
end
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
# Request message for creating a data product.
|
|
271
|
+
# @!attribute [rw] parent
|
|
272
|
+
# @return [::String]
|
|
273
|
+
# Required. The parent resource where this data product will be created.
|
|
274
|
+
# Format: projects/\\{project_id_or_number}/locations/\\{location_id}
|
|
275
|
+
# @!attribute [rw] data_product_id
|
|
276
|
+
# @return [::String]
|
|
277
|
+
# Optional. The ID of the data product to create.
|
|
278
|
+
#
|
|
279
|
+
# The ID must conform to RFC-1034 and contain only lower-case letters (a-z),
|
|
280
|
+
# numbers (0-9), or hyphens, with the first character a letter, the last a
|
|
281
|
+
# letter or a number, and a 63 character maximum. Characters outside of
|
|
282
|
+
# ASCII are not permitted.
|
|
283
|
+
# Valid format regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`
|
|
284
|
+
# If not provided, a system generated ID will be used.
|
|
285
|
+
# @!attribute [rw] data_product
|
|
286
|
+
# @return [::Google::Cloud::Dataplex::V1::DataProduct]
|
|
287
|
+
# Required. The data product to create.
|
|
288
|
+
# @!attribute [rw] validate_only
|
|
289
|
+
# @return [::Boolean]
|
|
290
|
+
# Optional. Validates the request without actually creating the data product.
|
|
291
|
+
# Default: false.
|
|
292
|
+
class CreateDataProductRequest
|
|
293
|
+
include ::Google::Protobuf::MessageExts
|
|
294
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
# Request message for deleting a data product.
|
|
298
|
+
# @!attribute [rw] name
|
|
299
|
+
# @return [::String]
|
|
300
|
+
# Required. The name of the data product to delete.
|
|
301
|
+
# Format:
|
|
302
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/dataProducts/\\{data_product_id}
|
|
303
|
+
# @!attribute [rw] etag
|
|
304
|
+
# @return [::String]
|
|
305
|
+
# Optional. The etag of the data product.
|
|
306
|
+
#
|
|
307
|
+
# If an etag is provided and does not match the current etag of the data
|
|
308
|
+
# product, then the deletion will be blocked and an ABORTED error will be
|
|
309
|
+
# returned.
|
|
310
|
+
# @!attribute [rw] validate_only
|
|
311
|
+
# @return [::Boolean]
|
|
312
|
+
# Optional. Validates the request without actually deleting the data product.
|
|
313
|
+
# Default: false.
|
|
314
|
+
class DeleteDataProductRequest
|
|
315
|
+
include ::Google::Protobuf::MessageExts
|
|
316
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
317
|
+
end
|
|
318
|
+
|
|
319
|
+
# Request message for getting a data product.
|
|
320
|
+
# @!attribute [rw] name
|
|
321
|
+
# @return [::String]
|
|
322
|
+
# Required. The name of the data product to retrieve.
|
|
323
|
+
# Format:
|
|
324
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/dataProducts/\\{data_product_id}
|
|
325
|
+
class GetDataProductRequest
|
|
326
|
+
include ::Google::Protobuf::MessageExts
|
|
327
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
328
|
+
end
|
|
329
|
+
|
|
330
|
+
# Request message for listing data products.
|
|
331
|
+
# @!attribute [rw] parent
|
|
332
|
+
# @return [::String]
|
|
333
|
+
# Required. The parent, which has this collection of data products.
|
|
334
|
+
#
|
|
335
|
+
# Format: `projects/{project_id_or_number}/locations/{location_id}`.
|
|
336
|
+
#
|
|
337
|
+
# Supports listing across all locations with the wildcard `-` (hyphen)
|
|
338
|
+
# character. Example: `projects/{project_id_or_number}/locations/-`
|
|
339
|
+
# @!attribute [rw] filter
|
|
340
|
+
# @return [::String]
|
|
341
|
+
# Optional. Filter expression that filters data products listed in the
|
|
342
|
+
# response.
|
|
343
|
+
#
|
|
344
|
+
# Example of using this filter is: `display_name="my-data-product"`
|
|
345
|
+
# @!attribute [rw] page_size
|
|
346
|
+
# @return [::Integer]
|
|
347
|
+
# Optional. The maximum number of data products to return. The service may
|
|
348
|
+
# return fewer than this value. If unspecified, at most 50 data products will
|
|
349
|
+
# be returned. The maximum value is 1000; values above 1000 will be coerced
|
|
350
|
+
# to 1000.
|
|
351
|
+
# @!attribute [rw] page_token
|
|
352
|
+
# @return [::String]
|
|
353
|
+
# Optional. A page token, received from a previous `ListDataProducts` call.
|
|
354
|
+
# Provide this to retrieve the subsequent page.
|
|
355
|
+
#
|
|
356
|
+
# When paginating, all other parameters provided to `ListDataProducts` must
|
|
357
|
+
# match the call that provided the page token.
|
|
358
|
+
# @!attribute [rw] order_by
|
|
359
|
+
# @return [::String]
|
|
360
|
+
# Optional. Order by expression that orders data products listed in the
|
|
361
|
+
# response.
|
|
362
|
+
#
|
|
363
|
+
# Supported Order by fields are: `name` or `create_time`.
|
|
364
|
+
#
|
|
365
|
+
# If not specified, the ordering is undefined.
|
|
366
|
+
#
|
|
367
|
+
# Ordering by `create_time` is not supported when listing resources across
|
|
368
|
+
# locations (i.e. when request contains `/locations/-`).
|
|
369
|
+
class ListDataProductsRequest
|
|
370
|
+
include ::Google::Protobuf::MessageExts
|
|
371
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
372
|
+
end
|
|
373
|
+
|
|
374
|
+
# Response message for listing data products.
|
|
375
|
+
# @!attribute [rw] data_products
|
|
376
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::DataProduct>]
|
|
377
|
+
# The data products for the requested filter criteria.
|
|
378
|
+
# @!attribute [rw] next_page_token
|
|
379
|
+
# @return [::String]
|
|
380
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
381
|
+
# If this field is empty, then there are no subsequent pages.
|
|
382
|
+
# @!attribute [rw] unreachable
|
|
383
|
+
# @return [::Array<::String>]
|
|
384
|
+
# Unordered list. Locations that the service couldn't reach.
|
|
385
|
+
class ListDataProductsResponse
|
|
386
|
+
include ::Google::Protobuf::MessageExts
|
|
387
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
388
|
+
end
|
|
389
|
+
|
|
390
|
+
# Request message for updating a data product.
|
|
391
|
+
# @!attribute [rw] data_product
|
|
392
|
+
# @return [::Google::Cloud::Dataplex::V1::DataProduct]
|
|
393
|
+
# Required. The data product to update.
|
|
394
|
+
# The data product's `name` field is used to identify the data product to
|
|
395
|
+
# update.
|
|
396
|
+
# @!attribute [rw] update_mask
|
|
397
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
398
|
+
# Optional. The list of fields to update.
|
|
399
|
+
# If this is empty or not set, then all the fields will be updated.
|
|
400
|
+
# @!attribute [rw] validate_only
|
|
401
|
+
# @return [::Boolean]
|
|
402
|
+
# Optional. Validates the request without actually updating the data product.
|
|
403
|
+
# Default: false.
|
|
404
|
+
class UpdateDataProductRequest
|
|
405
|
+
include ::Google::Protobuf::MessageExts
|
|
406
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
407
|
+
end
|
|
408
|
+
|
|
409
|
+
# Message for requesting access to a Data Product.
|
|
410
|
+
# @!attribute [rw] parent
|
|
411
|
+
# @return [::String]
|
|
412
|
+
# Required. The resource name of the data product.
|
|
413
|
+
# Format:
|
|
414
|
+
# projects/\\{project_number}/locations/\\{location_id}/dataProducts/\\{data_product_id}
|
|
415
|
+
# @!attribute [rw] change_request
|
|
416
|
+
# @return [::Google::Cloud::Dataplex::V1::ChangeRequest]
|
|
417
|
+
# Required. The change request for the data product access request.
|
|
418
|
+
# @!attribute [rw] validate_only
|
|
419
|
+
# @return [::Boolean]
|
|
420
|
+
# Optional. Validates the request without actually creating the access change
|
|
421
|
+
# request. Defaults to false.
|
|
422
|
+
class RequestDataProductAccessRequest
|
|
423
|
+
include ::Google::Protobuf::MessageExts
|
|
424
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
425
|
+
end
|
|
426
|
+
|
|
427
|
+
# Response message for requesting access to a Data Product.
|
|
428
|
+
# @!attribute [rw] change_request_name
|
|
429
|
+
# @return [::String]
|
|
430
|
+
# The resource name of the created ChangeRequest.
|
|
431
|
+
# Format:
|
|
432
|
+
# projects/\\{project_number}/locations/\\{location_id}/changeRequests/\\{change_request_id}
|
|
433
|
+
class RequestDataProductAccessResponse
|
|
434
|
+
include ::Google::Protobuf::MessageExts
|
|
435
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
436
|
+
end
|
|
437
|
+
|
|
438
|
+
# Request message for creating a data asset.
|
|
439
|
+
# @!attribute [rw] parent
|
|
440
|
+
# @return [::String]
|
|
441
|
+
# Required. The parent resource where this data asset will be created.
|
|
442
|
+
# Format:
|
|
443
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/dataProducts/\\{data_product_id}
|
|
444
|
+
# @!attribute [rw] data_asset_id
|
|
445
|
+
# @return [::String]
|
|
446
|
+
# Optional. The ID of the data asset to create.
|
|
447
|
+
#
|
|
448
|
+
# The ID must conform to RFC-1034 and contain only lower-case letters (a-z),
|
|
449
|
+
# numbers (0-9), or hyphens, with the first character a letter, the last a
|
|
450
|
+
# letter or a number, and a 63 character maximum. Characters outside of
|
|
451
|
+
# ASCII are not permitted.
|
|
452
|
+
# Valid format regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`
|
|
453
|
+
# If not provided, a system generated ID will be used.
|
|
454
|
+
# @!attribute [rw] data_asset
|
|
455
|
+
# @return [::Google::Cloud::Dataplex::V1::DataAsset]
|
|
456
|
+
# Required. The data asset to create.
|
|
457
|
+
# @!attribute [rw] validate_only
|
|
458
|
+
# @return [::Boolean]
|
|
459
|
+
# Optional. Validates the request without actually creating the data asset.
|
|
460
|
+
# Defaults to false.
|
|
461
|
+
class CreateDataAssetRequest
|
|
462
|
+
include ::Google::Protobuf::MessageExts
|
|
463
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
464
|
+
end
|
|
465
|
+
|
|
466
|
+
# Request message for updating a data asset.
|
|
467
|
+
# @!attribute [rw] data_asset
|
|
468
|
+
# @return [::Google::Cloud::Dataplex::V1::DataAsset]
|
|
469
|
+
# Required. The data asset to update.
|
|
470
|
+
# The data asset's `name` field is used to identify the data asset to update.
|
|
471
|
+
# @!attribute [rw] update_mask
|
|
472
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
473
|
+
# Optional. The list of fields to update.
|
|
474
|
+
# If this is empty or not set, then all the fields will be updated.
|
|
475
|
+
# @!attribute [rw] validate_only
|
|
476
|
+
# @return [::Boolean]
|
|
477
|
+
# Optional. Validates the request without actually updating the data asset.
|
|
478
|
+
# Defaults to false.
|
|
479
|
+
class UpdateDataAssetRequest
|
|
480
|
+
include ::Google::Protobuf::MessageExts
|
|
481
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
482
|
+
end
|
|
483
|
+
|
|
484
|
+
# Request message for deleting a data asset.
|
|
485
|
+
# @!attribute [rw] name
|
|
486
|
+
# @return [::String]
|
|
487
|
+
# Required. The name of the data asset to delete.
|
|
488
|
+
# Format:
|
|
489
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/dataProducts/\\{data_product_id}/dataAssets/\\{data_asset_id}
|
|
490
|
+
# @!attribute [rw] etag
|
|
491
|
+
# @return [::String]
|
|
492
|
+
# Optional. The etag of the data asset.
|
|
493
|
+
# If this is provided, it must match the server's etag.
|
|
494
|
+
# If the etag is provided and does not match the server-computed etag,
|
|
495
|
+
# the request must fail with a ABORTED error code.
|
|
496
|
+
# @!attribute [rw] validate_only
|
|
497
|
+
# @return [::Boolean]
|
|
498
|
+
# Optional. Validates the request without actually deleting the data asset.
|
|
499
|
+
# Defaults to false.
|
|
500
|
+
class DeleteDataAssetRequest
|
|
501
|
+
include ::Google::Protobuf::MessageExts
|
|
502
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
503
|
+
end
|
|
504
|
+
|
|
505
|
+
# Request message for getting a data asset.
|
|
506
|
+
# @!attribute [rw] name
|
|
507
|
+
# @return [::String]
|
|
508
|
+
# Required. The name of the data asset to retrieve.
|
|
509
|
+
# Format:
|
|
510
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/dataProducts/\\{data_product_id}/dataAssets/\\{data_asset_id}
|
|
511
|
+
class GetDataAssetRequest
|
|
512
|
+
include ::Google::Protobuf::MessageExts
|
|
513
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
514
|
+
end
|
|
515
|
+
|
|
516
|
+
# Request message for listing data assets.
|
|
517
|
+
# @!attribute [rw] parent
|
|
518
|
+
# @return [::String]
|
|
519
|
+
# Required. The parent, which has this collection of data assets.
|
|
520
|
+
# Format:
|
|
521
|
+
# projects/\\{project_id_or_number}/locations/\\{location_id}/dataProducts/\\{data_product_id}
|
|
522
|
+
# @!attribute [rw] filter
|
|
523
|
+
# @return [::String]
|
|
524
|
+
# Optional. Filter expression that filters data assets listed in the
|
|
525
|
+
# response.
|
|
526
|
+
# @!attribute [rw] order_by
|
|
527
|
+
# @return [::String]
|
|
528
|
+
# Optional. Order by expression that orders data assets listed in the
|
|
529
|
+
# response.
|
|
530
|
+
#
|
|
531
|
+
# Supported `order_by` fields are: `name` or `create_time`.
|
|
532
|
+
#
|
|
533
|
+
# If not specified, the ordering is undefined.
|
|
534
|
+
# @!attribute [rw] page_size
|
|
535
|
+
# @return [::Integer]
|
|
536
|
+
# Optional. The maximum number of data assets to return. The service may
|
|
537
|
+
# return fewer than this value. If unspecified, at most 50 data assets will
|
|
538
|
+
# be returned. The maximum value is 1000; values above 1000 will be coerced
|
|
539
|
+
# to 1000.
|
|
540
|
+
# @!attribute [rw] page_token
|
|
541
|
+
# @return [::String]
|
|
542
|
+
# Optional. A page token, received from a previous `ListDataAssets` call.
|
|
543
|
+
# Provide this to retrieve the subsequent page.
|
|
544
|
+
#
|
|
545
|
+
# When paginating, all other parameters provided to `ListDataAssets` must
|
|
546
|
+
# match the call that provided the page token.
|
|
547
|
+
class ListDataAssetsRequest
|
|
548
|
+
include ::Google::Protobuf::MessageExts
|
|
549
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
550
|
+
end
|
|
551
|
+
|
|
552
|
+
# Response message for listing data assets.
|
|
553
|
+
# @!attribute [rw] data_assets
|
|
554
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::DataAsset>]
|
|
555
|
+
# The data assets for the requested filter criteria.
|
|
556
|
+
# @!attribute [rw] next_page_token
|
|
557
|
+
# @return [::String]
|
|
558
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
559
|
+
# If this field is empty, then there are no subsequent pages.
|
|
560
|
+
class ListDataAssetsResponse
|
|
561
|
+
include ::Google::Protobuf::MessageExts
|
|
562
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
563
|
+
end
|
|
564
|
+
end
|
|
565
|
+
end
|
|
566
|
+
end
|
|
567
|
+
end
|
|
@@ -56,6 +56,9 @@ module Google
|
|
|
56
56
|
# @return [::Boolean]
|
|
57
57
|
# Optional. If set, the latest DataScan job result will be published as
|
|
58
58
|
# Dataplex Universal Catalog metadata.
|
|
59
|
+
# @!attribute [rw] mode
|
|
60
|
+
# @return [::Google::Cloud::Dataplex::V1::DataProfileSpec::Mode]
|
|
61
|
+
# Optional. The execution mode for the profile scan.
|
|
59
62
|
class DataProfileSpec
|
|
60
63
|
include ::Google::Protobuf::MessageExts
|
|
61
64
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -95,6 +98,24 @@ module Google
|
|
|
95
98
|
include ::Google::Protobuf::MessageExts
|
|
96
99
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
97
100
|
end
|
|
101
|
+
|
|
102
|
+
# Defines the execution mode for the profile scan.
|
|
103
|
+
module Mode
|
|
104
|
+
# Default value. This value is unused.
|
|
105
|
+
MODE_UNSPECIFIED = 0
|
|
106
|
+
|
|
107
|
+
# Performs standard profiling. The behavior is controlled by other fields
|
|
108
|
+
# such as `sampling_percent`, `row_filter`, and column filters.
|
|
109
|
+
# This mode allows for full scans or custom sampling.
|
|
110
|
+
STANDARD = 1
|
|
111
|
+
|
|
112
|
+
# Specifies lightweight profiling mode. This mode is optimized for
|
|
113
|
+
# low-latency, low-fidelity profiling.
|
|
114
|
+
#
|
|
115
|
+
# When this mode is selected, the following fields must not be set:
|
|
116
|
+
# `sampling_percent`, `row_filter`, `include_fields`, and `exclude_fields`.
|
|
117
|
+
LIGHTWEIGHT = 2
|
|
118
|
+
end
|
|
98
119
|
end
|
|
99
120
|
|
|
100
121
|
# DataProfileResult defines the output of DataProfileScan. Each field of the
|