google-cloud-dataplex-v1 0.5.1 → 0.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/dataplex/v1/content_service.rb +1 -1
- data/lib/google/cloud/dataplex/v1/data_profile_pb.rb +78 -0
- data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +108 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +1171 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/credentials.rb +47 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +770 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +113 -0
- data/lib/google/cloud/dataplex/v1/data_scan_service.rb +48 -0
- data/lib/google/cloud/dataplex/v1/dataplex_service.rb +1 -1
- data/lib/google/cloud/dataplex/v1/datascans_pb.rb +169 -0
- data/lib/google/cloud/dataplex/v1/datascans_services_pb.rb +58 -0
- data/lib/google/cloud/dataplex/v1/logs_pb.rb +53 -0
- data/lib/google/cloud/dataplex/v1/metadata_pb.rb +5 -0
- data/lib/google/cloud/dataplex/v1/metadata_service.rb +1 -1
- data/lib/google/cloud/dataplex/v1/processing_pb.rb +53 -0
- data/lib/google/cloud/dataplex/v1/version.rb +1 -1
- data/lib/google/cloud/dataplex/v1.rb +3 -2
- data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +232 -0
- data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +274 -0
- data/proto_docs/google/cloud/dataplex/v1/datascans.rb +418 -0
- data/proto_docs/google/cloud/dataplex/v1/logs.rb +135 -2
- data/proto_docs/google/cloud/dataplex/v1/metadata.rb +16 -0
- data/proto_docs/google/cloud/dataplex/v1/processing.rb +96 -0
- metadata +18 -4
@@ -0,0 +1,418 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 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
|
+
# Create dataScan request.
|
25
|
+
# @!attribute [rw] parent
|
26
|
+
# @return [::String]
|
27
|
+
# Required. The resource name of the parent location:
|
28
|
+
# projects/\\{project}/locations/\\{location_id}
|
29
|
+
# where `{project}` refers to a project_id or project_number and
|
30
|
+
# `location_id` refers to a GCP region.
|
31
|
+
# @!attribute [rw] data_scan
|
32
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScan]
|
33
|
+
# Required. DataScan resource.
|
34
|
+
# @!attribute [rw] data_scan_id
|
35
|
+
# @return [::String]
|
36
|
+
# Required. DataScan identifier.
|
37
|
+
# * Must contain only lowercase letters, numbers and hyphens.
|
38
|
+
# * Must start with a letter.
|
39
|
+
# * Must end with a number or a letter.
|
40
|
+
# * Must be between 1-63 characters.
|
41
|
+
# * Must be unique within the customer project / location.
|
42
|
+
class CreateDataScanRequest
|
43
|
+
include ::Google::Protobuf::MessageExts
|
44
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
45
|
+
end
|
46
|
+
|
47
|
+
# Update dataScan request.
|
48
|
+
# @!attribute [rw] data_scan
|
49
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScan]
|
50
|
+
# Required. Update description.
|
51
|
+
# Only fields specified in `update_mask` are updated.
|
52
|
+
# @!attribute [rw] update_mask
|
53
|
+
# @return [::Google::Protobuf::FieldMask]
|
54
|
+
# Required. Mask of fields to update.
|
55
|
+
class UpdateDataScanRequest
|
56
|
+
include ::Google::Protobuf::MessageExts
|
57
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
58
|
+
end
|
59
|
+
|
60
|
+
# Delete dataScan request.
|
61
|
+
# @!attribute [rw] name
|
62
|
+
# @return [::String]
|
63
|
+
# Required. The resource name of the dataScan:
|
64
|
+
# projects/\\{project}/locations/\\{location_id}/dataScans/\\{data_scan_id}
|
65
|
+
# where `{project}` refers to a project_id or project_number and
|
66
|
+
# `location_id` refers to a GCP region.
|
67
|
+
class DeleteDataScanRequest
|
68
|
+
include ::Google::Protobuf::MessageExts
|
69
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
|
+
end
|
71
|
+
|
72
|
+
# Get dataScan request.
|
73
|
+
# @!attribute [rw] name
|
74
|
+
# @return [::String]
|
75
|
+
# Required. The resource name of the dataScan:
|
76
|
+
# projects/\\{project}/locations/\\{location_id}/dataScans/\\{data_scan_id}
|
77
|
+
# where `{project}` refers to a project_id or project_number and
|
78
|
+
# `location_id` refers to a GCP region.
|
79
|
+
# @!attribute [rw] view
|
80
|
+
# @return [::Google::Cloud::Dataplex::V1::GetDataScanRequest::DataScanView]
|
81
|
+
# Optional. Used to select the subset of DataScan information to return.
|
82
|
+
# Defaults to `BASIC`.
|
83
|
+
class GetDataScanRequest
|
84
|
+
include ::Google::Protobuf::MessageExts
|
85
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
86
|
+
|
87
|
+
# DataScan views for getting a partial dataScan.
|
88
|
+
module DataScanView
|
89
|
+
# The API will default to the `BASIC` view.
|
90
|
+
DATA_SCAN_VIEW_UNSPECIFIED = 0
|
91
|
+
|
92
|
+
# Basic view that does not include spec and result.
|
93
|
+
BASIC = 1
|
94
|
+
|
95
|
+
# Include everything.
|
96
|
+
FULL = 10
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
# List dataScans request.
|
101
|
+
# @!attribute [rw] parent
|
102
|
+
# @return [::String]
|
103
|
+
# Required. projects/\\{project}/locations/\\{location_id}
|
104
|
+
# where `{project}` refers to a project_id or project_number and
|
105
|
+
# `location_id` refers to a GCP region.
|
106
|
+
# @!attribute [rw] page_size
|
107
|
+
# @return [::Integer]
|
108
|
+
# Optional. Maximum number of dataScans to return. The service may return
|
109
|
+
# fewer than this value. If unspecified, at most 10 scans will be returned.
|
110
|
+
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
111
|
+
# @!attribute [rw] page_token
|
112
|
+
# @return [::String]
|
113
|
+
# Optional. Page token received from a previous `ListDataScans` call. Provide
|
114
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
115
|
+
# provided to `ListDataScans` must match the call that provided the
|
116
|
+
# page token.
|
117
|
+
# @!attribute [rw] filter
|
118
|
+
# @return [::String]
|
119
|
+
# Optional. Filter request.
|
120
|
+
# @!attribute [rw] order_by
|
121
|
+
# @return [::String]
|
122
|
+
# Optional. Order by fields (name or create_time) for the result.
|
123
|
+
# If not specified, the ordering is undefined.
|
124
|
+
class ListDataScansRequest
|
125
|
+
include ::Google::Protobuf::MessageExts
|
126
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
127
|
+
end
|
128
|
+
|
129
|
+
# List dataScans response.
|
130
|
+
# @!attribute [rw] data_scans
|
131
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::DataScan>]
|
132
|
+
# DataScans (metadata only) under the given parent location.
|
133
|
+
# @!attribute [rw] next_page_token
|
134
|
+
# @return [::String]
|
135
|
+
# Token to retrieve the next page of results, or empty if there are no more
|
136
|
+
# results in the list.
|
137
|
+
# @!attribute [rw] unreachable
|
138
|
+
# @return [::Array<::String>]
|
139
|
+
# Locations that could not be reached.
|
140
|
+
class ListDataScansResponse
|
141
|
+
include ::Google::Protobuf::MessageExts
|
142
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
143
|
+
end
|
144
|
+
|
145
|
+
# Run DataScan Request
|
146
|
+
# @!attribute [rw] name
|
147
|
+
# @return [::String]
|
148
|
+
# Required. The resource name of the DataScan:
|
149
|
+
# projects/\\{project}/locations/\\{location_id}/dataScans/\\{data_scan_id}.
|
150
|
+
# where `{project}` refers to a project_id or project_number and
|
151
|
+
# `location_id` refers to a GCP region.
|
152
|
+
# Only on-demand DataScans are allowed.
|
153
|
+
class RunDataScanRequest
|
154
|
+
include ::Google::Protobuf::MessageExts
|
155
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
156
|
+
end
|
157
|
+
|
158
|
+
# Run DataScan Response.
|
159
|
+
# @!attribute [rw] job
|
160
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScanJob]
|
161
|
+
# DataScanJob created by RunDataScan API.
|
162
|
+
class RunDataScanResponse
|
163
|
+
include ::Google::Protobuf::MessageExts
|
164
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
165
|
+
end
|
166
|
+
|
167
|
+
# Get DataScanJob request.
|
168
|
+
# @!attribute [rw] name
|
169
|
+
# @return [::String]
|
170
|
+
# Required. The resource name of the DataScanJob:
|
171
|
+
# projects/\\{project}/locations/\\{location_id}/dataScans/\\{data_scan_id}/dataScanJobs/\\{data_scan_job_id}
|
172
|
+
# where `{project}` refers to a project_id or project_number and
|
173
|
+
# `location_id` refers to a GCP region.
|
174
|
+
# @!attribute [rw] view
|
175
|
+
# @return [::Google::Cloud::Dataplex::V1::GetDataScanJobRequest::DataScanJobView]
|
176
|
+
# Optional. Used to select the subset of DataScan information to return.
|
177
|
+
# Defaults to `BASIC`.
|
178
|
+
class GetDataScanJobRequest
|
179
|
+
include ::Google::Protobuf::MessageExts
|
180
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
181
|
+
|
182
|
+
# DataScanJob views for getting a partial dataScanJob.
|
183
|
+
module DataScanJobView
|
184
|
+
# The API will default to the `BASIC` view.
|
185
|
+
DATA_SCAN_JOB_VIEW_UNSPECIFIED = 0
|
186
|
+
|
187
|
+
# Basic view that does not include spec and result.
|
188
|
+
BASIC = 1
|
189
|
+
|
190
|
+
# Include everything.
|
191
|
+
FULL = 10
|
192
|
+
end
|
193
|
+
end
|
194
|
+
|
195
|
+
# List DataScanJobs request.
|
196
|
+
# @!attribute [rw] parent
|
197
|
+
# @return [::String]
|
198
|
+
# Required. The resource name of the parent environment:
|
199
|
+
# projects/\\{project}/locations/\\{location_id}/dataScans/\\{data_scan_id}
|
200
|
+
# where `{project}` refers to a project_id or project_number and
|
201
|
+
# `location_id` refers to a GCP region.
|
202
|
+
# @!attribute [rw] page_size
|
203
|
+
# @return [::Integer]
|
204
|
+
# Optional. Maximum number of DataScanJobs to return. The service may return
|
205
|
+
# fewer than this value. If unspecified, at most 10 DataScanJobs will be
|
206
|
+
# returned. The maximum value is 1000; values above 1000 will be coerced to
|
207
|
+
# 1000.
|
208
|
+
# @!attribute [rw] page_token
|
209
|
+
# @return [::String]
|
210
|
+
# Optional. Page token received from a previous `ListDataScanJobs` call.
|
211
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
212
|
+
# parameters provided to `ListDataScanJobs` must match the call that provided
|
213
|
+
# the page token.
|
214
|
+
class ListDataScanJobsRequest
|
215
|
+
include ::Google::Protobuf::MessageExts
|
216
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
217
|
+
end
|
218
|
+
|
219
|
+
# List DataScanJobs response.
|
220
|
+
# @!attribute [rw] data_scan_jobs
|
221
|
+
# @return [::Array<::Google::Cloud::Dataplex::V1::DataScanJob>]
|
222
|
+
# DataScanJobs (metadata only) under a given dataScan.
|
223
|
+
# @!attribute [rw] next_page_token
|
224
|
+
# @return [::String]
|
225
|
+
# Token to retrieve the next page of results, or empty if there are no more
|
226
|
+
# results in the list.
|
227
|
+
class ListDataScanJobsResponse
|
228
|
+
include ::Google::Protobuf::MessageExts
|
229
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
230
|
+
end
|
231
|
+
|
232
|
+
# Represents a user-visible job which provides the insights for the related
|
233
|
+
# data source.
|
234
|
+
#
|
235
|
+
# For example:
|
236
|
+
#
|
237
|
+
# * Data Quality: generates queries based on the rules and runs against the
|
238
|
+
# data to get data quality check results.
|
239
|
+
# * Data Profile: analyzes the data in table(s) and generates insights about
|
240
|
+
# the structure, content and relationships (such as null percent,
|
241
|
+
# cardinality, min/max/mean, etc).
|
242
|
+
# @!attribute [r] name
|
243
|
+
# @return [::String]
|
244
|
+
# Output only. The relative resource name of the scan, of the form:
|
245
|
+
# projects/\\{project}/locations/\\{location_id}/dataScans/\\{datascan_id}.
|
246
|
+
# where `{project}` refers to a project_id or project_number and
|
247
|
+
# `location_id` refers to a GCP region.
|
248
|
+
# @!attribute [r] uid
|
249
|
+
# @return [::String]
|
250
|
+
# Output only. System generated globally unique ID for the scan. This ID will
|
251
|
+
# be different if the scan is deleted and re-created with the same name.
|
252
|
+
# @!attribute [rw] description
|
253
|
+
# @return [::String]
|
254
|
+
# Optional. Description of the scan.
|
255
|
+
# * Must be between 1-1024 characters.
|
256
|
+
# @!attribute [rw] display_name
|
257
|
+
# @return [::String]
|
258
|
+
# Optional. User friendly display name.
|
259
|
+
# * Must be between 1-256 characters.
|
260
|
+
# @!attribute [rw] labels
|
261
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
262
|
+
# Optional. User-defined labels for the scan.
|
263
|
+
# @!attribute [r] state
|
264
|
+
# @return [::Google::Cloud::Dataplex::V1::State]
|
265
|
+
# Output only. Current state of the DataScan.
|
266
|
+
# @!attribute [r] create_time
|
267
|
+
# @return [::Google::Protobuf::Timestamp]
|
268
|
+
# Output only. The time when the scan was created.
|
269
|
+
# @!attribute [r] update_time
|
270
|
+
# @return [::Google::Protobuf::Timestamp]
|
271
|
+
# Output only. The time when the scan was last updated.
|
272
|
+
# @!attribute [rw] data
|
273
|
+
# @return [::Google::Cloud::Dataplex::V1::DataSource]
|
274
|
+
# Required. The data source for DataScan.
|
275
|
+
# @!attribute [rw] execution_spec
|
276
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScan::ExecutionSpec]
|
277
|
+
# Optional. DataScan execution settings.
|
278
|
+
# If not specified, the fields under it will use their default values.
|
279
|
+
# @!attribute [r] execution_status
|
280
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScan::ExecutionStatus]
|
281
|
+
# Output only. Status of the data scan execution.
|
282
|
+
# @!attribute [r] type
|
283
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScanType]
|
284
|
+
# Output only. The type of DataScan.
|
285
|
+
# @!attribute [rw] data_quality_spec
|
286
|
+
# @return [::Google::Cloud::Dataplex::V1::DataQualitySpec]
|
287
|
+
# DataQualityScan related setting.
|
288
|
+
# @!attribute [rw] data_profile_spec
|
289
|
+
# @return [::Google::Cloud::Dataplex::V1::DataProfileSpec]
|
290
|
+
# DataProfileScan related setting.
|
291
|
+
# @!attribute [r] data_quality_result
|
292
|
+
# @return [::Google::Cloud::Dataplex::V1::DataQualityResult]
|
293
|
+
# Output only. The result of the data quality scan.
|
294
|
+
# @!attribute [r] data_profile_result
|
295
|
+
# @return [::Google::Cloud::Dataplex::V1::DataProfileResult]
|
296
|
+
# Output only. The result of the data profile scan.
|
297
|
+
class DataScan
|
298
|
+
include ::Google::Protobuf::MessageExts
|
299
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
300
|
+
|
301
|
+
# DataScan execution settings.
|
302
|
+
# @!attribute [rw] trigger
|
303
|
+
# @return [::Google::Cloud::Dataplex::V1::Trigger]
|
304
|
+
# Optional. Spec related to how often and when a scan should be triggered.
|
305
|
+
# If not specified, the default is OnDemand, which means the scan will not
|
306
|
+
# run until the user calls RunDataScan API.
|
307
|
+
# @!attribute [rw] field
|
308
|
+
# @return [::String]
|
309
|
+
# Immutable. The unnested field (Date or Timestamp) that contains values
|
310
|
+
# that monotonically increase over time.
|
311
|
+
class ExecutionSpec
|
312
|
+
include ::Google::Protobuf::MessageExts
|
313
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
314
|
+
end
|
315
|
+
|
316
|
+
# Status of the data scan execution.
|
317
|
+
# @!attribute [rw] latest_job_start_time
|
318
|
+
# @return [::Google::Protobuf::Timestamp]
|
319
|
+
# The time when the latest DataScanJob started.
|
320
|
+
# @!attribute [rw] latest_job_end_time
|
321
|
+
# @return [::Google::Protobuf::Timestamp]
|
322
|
+
# The time when the latest DataScanJob ended.
|
323
|
+
class ExecutionStatus
|
324
|
+
include ::Google::Protobuf::MessageExts
|
325
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
326
|
+
end
|
327
|
+
|
328
|
+
# @!attribute [rw] key
|
329
|
+
# @return [::String]
|
330
|
+
# @!attribute [rw] value
|
331
|
+
# @return [::String]
|
332
|
+
class LabelsEntry
|
333
|
+
include ::Google::Protobuf::MessageExts
|
334
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
335
|
+
end
|
336
|
+
end
|
337
|
+
|
338
|
+
# A DataScanJob represents an instance of a data scan.
|
339
|
+
# @!attribute [r] name
|
340
|
+
# @return [::String]
|
341
|
+
# Output only. The relative resource name of the DataScanJob, of the form:
|
342
|
+
# projects/\\{project}/locations/\\{location_id}/dataScans/\\{datascan_id}/jobs/\\{job_id}.
|
343
|
+
# where `{project}` refers to a project_id or project_number and
|
344
|
+
# `location_id` refers to a GCP region.
|
345
|
+
# @!attribute [r] uid
|
346
|
+
# @return [::String]
|
347
|
+
# Output only. System generated globally unique ID for the DataScanJob.
|
348
|
+
# @!attribute [r] start_time
|
349
|
+
# @return [::Google::Protobuf::Timestamp]
|
350
|
+
# Output only. The time when the DataScanJob was started.
|
351
|
+
# @!attribute [r] end_time
|
352
|
+
# @return [::Google::Protobuf::Timestamp]
|
353
|
+
# Output only. The time when the DataScanJob ended.
|
354
|
+
# @!attribute [r] state
|
355
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScanJob::State]
|
356
|
+
# Output only. Execution state for the DataScanJob.
|
357
|
+
# @!attribute [r] message
|
358
|
+
# @return [::String]
|
359
|
+
# Output only. Additional information about the current state.
|
360
|
+
# @!attribute [r] type
|
361
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScanType]
|
362
|
+
# Output only. The type of the parent DataScan.
|
363
|
+
# @!attribute [r] data_quality_spec
|
364
|
+
# @return [::Google::Cloud::Dataplex::V1::DataQualitySpec]
|
365
|
+
# Output only. DataQualityScan related setting.
|
366
|
+
# @!attribute [r] data_profile_spec
|
367
|
+
# @return [::Google::Cloud::Dataplex::V1::DataProfileSpec]
|
368
|
+
# Output only. DataProfileScan related setting.
|
369
|
+
# @!attribute [r] data_quality_result
|
370
|
+
# @return [::Google::Cloud::Dataplex::V1::DataQualityResult]
|
371
|
+
# Output only. The result of the data quality scan.
|
372
|
+
# @!attribute [r] data_profile_result
|
373
|
+
# @return [::Google::Cloud::Dataplex::V1::DataProfileResult]
|
374
|
+
# Output only. The result of the data profile scan.
|
375
|
+
class DataScanJob
|
376
|
+
include ::Google::Protobuf::MessageExts
|
377
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
378
|
+
|
379
|
+
# Execution state for the DataScanJob.
|
380
|
+
module State
|
381
|
+
# The DataScanJob state is unspecified.
|
382
|
+
STATE_UNSPECIFIED = 0
|
383
|
+
|
384
|
+
# The DataScanJob is running.
|
385
|
+
RUNNING = 1
|
386
|
+
|
387
|
+
# The DataScanJob is canceling.
|
388
|
+
CANCELING = 2
|
389
|
+
|
390
|
+
# The DataScanJob cancellation was successful.
|
391
|
+
CANCELLED = 3
|
392
|
+
|
393
|
+
# The DataScanJob completed successfully.
|
394
|
+
SUCCEEDED = 4
|
395
|
+
|
396
|
+
# The DataScanJob is no longer running due to an error.
|
397
|
+
FAILED = 5
|
398
|
+
|
399
|
+
# The DataScanJob has been created but not started to run yet.
|
400
|
+
PENDING = 7
|
401
|
+
end
|
402
|
+
end
|
403
|
+
|
404
|
+
# The type of DataScan.
|
405
|
+
module DataScanType
|
406
|
+
# The DataScan Type is unspecified.
|
407
|
+
DATA_SCAN_TYPE_UNSPECIFIED = 0
|
408
|
+
|
409
|
+
# Data Quality Scan.
|
410
|
+
DATA_QUALITY = 1
|
411
|
+
|
412
|
+
# Data Profile Scan.
|
413
|
+
DATA_PROFILE = 2
|
414
|
+
end
|
415
|
+
end
|
416
|
+
end
|
417
|
+
end
|
418
|
+
end
|
@@ -257,8 +257,8 @@ module Google
|
|
257
257
|
# The status of the event.
|
258
258
|
# @!attribute [rw] fast_startup_enabled
|
259
259
|
# @return [::Boolean]
|
260
|
-
# If the session is associated with an
|
261
|
-
# and was
|
260
|
+
# If the session is associated with an environment with fast startup enabled,
|
261
|
+
# and was created before being assigned to a user.
|
262
262
|
# @!attribute [rw] unassigned_duration
|
263
263
|
# @return [::Google::Protobuf::Duration]
|
264
264
|
# The idle duration of a warm pooled session before it is assigned to user.
|
@@ -321,6 +321,139 @@ module Google
|
|
321
321
|
CREATE = 4
|
322
322
|
end
|
323
323
|
end
|
324
|
+
|
325
|
+
# These messages contain information about the execution of a datascan.
|
326
|
+
# The monitored resource is 'DataScan'
|
327
|
+
# @!attribute [rw] data_source
|
328
|
+
# @return [::String]
|
329
|
+
# The data source of the data scan
|
330
|
+
# @!attribute [rw] job_id
|
331
|
+
# @return [::String]
|
332
|
+
# The identifier of the specific data scan job this log entry is for.
|
333
|
+
# @!attribute [rw] start_time
|
334
|
+
# @return [::Google::Protobuf::Timestamp]
|
335
|
+
# The time when the data scan job started to run.
|
336
|
+
# @!attribute [rw] end_time
|
337
|
+
# @return [::Google::Protobuf::Timestamp]
|
338
|
+
# The time when the data scan job finished.
|
339
|
+
# @!attribute [rw] type
|
340
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScanEvent::ScanType]
|
341
|
+
# The type of the data scan.
|
342
|
+
# @!attribute [rw] state
|
343
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScanEvent::State]
|
344
|
+
# The status of the data scan job.
|
345
|
+
# @!attribute [rw] message
|
346
|
+
# @return [::String]
|
347
|
+
# The message describing the data scan job event.
|
348
|
+
# @!attribute [rw] spec_version
|
349
|
+
# @return [::String]
|
350
|
+
# A version identifier of the spec which was used to execute this job.
|
351
|
+
# @!attribute [rw] trigger
|
352
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScanEvent::Trigger]
|
353
|
+
# The trigger type of the data scan job.
|
354
|
+
# @!attribute [rw] scope
|
355
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScanEvent::Scope]
|
356
|
+
# The scope of the data scan (e.g. full, incremental).
|
357
|
+
# @!attribute [rw] data_profile
|
358
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScanEvent::DataProfileResult]
|
359
|
+
# Data profile result for data profile type data scan.
|
360
|
+
# @!attribute [rw] data_quality
|
361
|
+
# @return [::Google::Cloud::Dataplex::V1::DataScanEvent::DataQualityResult]
|
362
|
+
# Data quality result for data quality type data scan.
|
363
|
+
class DataScanEvent
|
364
|
+
include ::Google::Protobuf::MessageExts
|
365
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
366
|
+
|
367
|
+
# Data profile result for data scan job.
|
368
|
+
# @!attribute [rw] row_count
|
369
|
+
# @return [::Integer]
|
370
|
+
# The count of rows processed in the data scan job.
|
371
|
+
class DataProfileResult
|
372
|
+
include ::Google::Protobuf::MessageExts
|
373
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
374
|
+
end
|
375
|
+
|
376
|
+
# Data quality result for data scan job.
|
377
|
+
# @!attribute [rw] row_count
|
378
|
+
# @return [::Integer]
|
379
|
+
# The count of rows processed in the data scan job.
|
380
|
+
# @!attribute [rw] passed
|
381
|
+
# @return [::Boolean]
|
382
|
+
# Whether the data quality result was `pass` or not.
|
383
|
+
# @!attribute [rw] dimension_passed
|
384
|
+
# @return [::Google::Protobuf::Map{::String => ::Boolean}]
|
385
|
+
# The result of each dimension for data quality result.
|
386
|
+
# The key of the map is the name of the dimension.
|
387
|
+
# The value is the bool value depicting whether the dimension result was
|
388
|
+
# `pass` or not.
|
389
|
+
class DataQualityResult
|
390
|
+
include ::Google::Protobuf::MessageExts
|
391
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
392
|
+
|
393
|
+
# @!attribute [rw] key
|
394
|
+
# @return [::String]
|
395
|
+
# @!attribute [rw] value
|
396
|
+
# @return [::Boolean]
|
397
|
+
class DimensionPassedEntry
|
398
|
+
include ::Google::Protobuf::MessageExts
|
399
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
400
|
+
end
|
401
|
+
end
|
402
|
+
|
403
|
+
# The type of the data scan.
|
404
|
+
module ScanType
|
405
|
+
# An unspecified data scan type.
|
406
|
+
SCAN_TYPE_UNSPECIFIED = 0
|
407
|
+
|
408
|
+
# Data scan for data profile.
|
409
|
+
DATA_PROFILE = 1
|
410
|
+
|
411
|
+
# Data scan for data quality.
|
412
|
+
DATA_QUALITY = 2
|
413
|
+
end
|
414
|
+
|
415
|
+
# The job state of the data scan.
|
416
|
+
module State
|
417
|
+
# Unspecified job state.
|
418
|
+
STATE_UNSPECIFIED = 0
|
419
|
+
|
420
|
+
# Data scan started.
|
421
|
+
STARTED = 1
|
422
|
+
|
423
|
+
# Data scan successfully completed.
|
424
|
+
SUCCEEDED = 2
|
425
|
+
|
426
|
+
# Data scan was unsuccessful.
|
427
|
+
FAILED = 3
|
428
|
+
|
429
|
+
# Data scan was cancelled.
|
430
|
+
CANCELLED = 4
|
431
|
+
end
|
432
|
+
|
433
|
+
# The trigger type for the data scan.
|
434
|
+
module Trigger
|
435
|
+
# An unspecified trigger type.
|
436
|
+
TRIGGER_UNSPECIFIED = 0
|
437
|
+
|
438
|
+
# Data scan triggers on demand.
|
439
|
+
ON_DEMAND = 1
|
440
|
+
|
441
|
+
# Data scan triggers as per schedule.
|
442
|
+
SCHEDULE = 2
|
443
|
+
end
|
444
|
+
|
445
|
+
# The scope of job for the data scan.
|
446
|
+
module Scope
|
447
|
+
# An unspecified scope type.
|
448
|
+
SCOPE_UNSPECIFIED = 0
|
449
|
+
|
450
|
+
# Data scan runs on all of the data.
|
451
|
+
FULL = 1
|
452
|
+
|
453
|
+
# Data scan runs on incremental data.
|
454
|
+
INCREMENTAL = 2
|
455
|
+
end
|
456
|
+
end
|
324
457
|
end
|
325
458
|
end
|
326
459
|
end
|
@@ -565,6 +565,9 @@ module Google
|
|
565
565
|
# - application/x-avro
|
566
566
|
# - application/x-orc
|
567
567
|
# - application/x-tfrecord
|
568
|
+
# - application/x-parquet+iceberg
|
569
|
+
# - application/x-avro+iceberg
|
570
|
+
# - application/x-orc+iceberg
|
568
571
|
# - application/json
|
569
572
|
# - application/\\{subtypes}
|
570
573
|
# - text/csv
|
@@ -578,6 +581,9 @@ module Google
|
|
578
581
|
# @!attribute [rw] json
|
579
582
|
# @return [::Google::Cloud::Dataplex::V1::StorageFormat::JsonOptions]
|
580
583
|
# Optional. Additional information about CSV formatted data.
|
584
|
+
# @!attribute [rw] iceberg
|
585
|
+
# @return [::Google::Cloud::Dataplex::V1::StorageFormat::IcebergOptions]
|
586
|
+
# Optional. Additional information about iceberg tables.
|
581
587
|
class StorageFormat
|
582
588
|
include ::Google::Protobuf::MessageExts
|
583
589
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -614,6 +620,16 @@ module Google
|
|
614
620
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
615
621
|
end
|
616
622
|
|
623
|
+
# Describes Iceberg data format.
|
624
|
+
# @!attribute [rw] metadata_location
|
625
|
+
# @return [::String]
|
626
|
+
# Optional. The location of where the iceberg metadata is present, must be
|
627
|
+
# within the table path
|
628
|
+
class IcebergOptions
|
629
|
+
include ::Google::Protobuf::MessageExts
|
630
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
631
|
+
end
|
632
|
+
|
617
633
|
# The specific file format of the data.
|
618
634
|
module Format
|
619
635
|
# Format unspecified.
|