google-cloud-dataplex-v1 2.5.0 → 2.6.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 (68) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dataplex/v1/bindings_override.rb +34 -29
  4. data/lib/google/cloud/dataplex/v1/business_glossary_pb.rb +75 -0
  5. data/lib/google/cloud/dataplex/v1/business_glossary_service/client.rb +1985 -0
  6. data/lib/google/cloud/dataplex/v1/business_glossary_service/credentials.rb +47 -0
  7. data/lib/google/cloud/dataplex/v1/business_glossary_service/operations.rb +813 -0
  8. data/lib/google/cloud/dataplex/v1/business_glossary_service/paths.rb +111 -0
  9. data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/client.rb +1863 -0
  10. data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/operations.rb +943 -0
  11. data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/service_stub.rb +1002 -0
  12. data/lib/google/cloud/dataplex/v1/business_glossary_service/rest.rb +59 -0
  13. data/lib/google/cloud/dataplex/v1/business_glossary_service.rb +61 -0
  14. data/lib/google/cloud/dataplex/v1/business_glossary_services_pb.rb +81 -0
  15. data/lib/google/cloud/dataplex/v1/catalog_pb.rb +7 -1
  16. data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +298 -10
  17. data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +40 -0
  18. data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +277 -10
  19. data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +2 -2
  20. data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +184 -0
  21. data/lib/google/cloud/dataplex/v1/catalog_service/rest.rb +4 -4
  22. data/lib/google/cloud/dataplex/v1/catalog_service.rb +4 -4
  23. data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +14 -6
  24. data/lib/google/cloud/dataplex/v1/cmek_service/client.rb +1 -1
  25. data/lib/google/cloud/dataplex/v1/cmek_service/rest/client.rb +1 -1
  26. data/lib/google/cloud/dataplex/v1/cmek_service/rest/operations.rb +2 -2
  27. data/lib/google/cloud/dataplex/v1/cmek_service/rest.rb +1 -1
  28. data/lib/google/cloud/dataplex/v1/cmek_service.rb +1 -1
  29. data/lib/google/cloud/dataplex/v1/cmek_services_pb.rb +1 -1
  30. data/lib/google/cloud/dataplex/v1/content_service/client.rb +2 -1
  31. data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +2 -1
  32. data/lib/google/cloud/dataplex/v1/content_service/rest.rb +2 -1
  33. data/lib/google/cloud/dataplex/v1/content_service.rb +2 -1
  34. data/lib/google/cloud/dataplex/v1/content_services_pb.rb +2 -1
  35. data/lib/google/cloud/dataplex/v1/data_discovery_pb.rb +1 -1
  36. data/lib/google/cloud/dataplex/v1/data_profile_pb.rb +1 -1
  37. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +3 -1
  38. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +7 -7
  39. data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +14 -0
  40. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +7 -7
  41. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +2 -2
  42. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/client.rb +1 -1
  43. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/client.rb +1 -1
  44. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +2 -2
  45. data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +2 -2
  46. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +2 -2
  47. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +2 -2
  48. data/lib/google/cloud/dataplex/v1/datascans_common_pb.rb +45 -0
  49. data/lib/google/cloud/dataplex/v1/logs_pb.rb +3 -1
  50. data/lib/google/cloud/dataplex/v1/processing_pb.rb +1 -1
  51. data/lib/google/cloud/dataplex/v1/rest.rb +1 -0
  52. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  53. data/lib/google/cloud/dataplex/v1.rb +1 -0
  54. data/proto_docs/google/cloud/dataplex/v1/analyze.rb +1 -1
  55. data/proto_docs/google/cloud/dataplex/v1/business_glossary.rb +531 -0
  56. data/proto_docs/google/cloud/dataplex/v1/catalog.rb +192 -33
  57. data/proto_docs/google/cloud/dataplex/v1/data_discovery.rb +6 -0
  58. data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +99 -98
  59. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +18 -5
  60. data/proto_docs/google/cloud/dataplex/v1/data_taxonomy.rb +1 -1
  61. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +11 -11
  62. data/proto_docs/google/cloud/dataplex/v1/datascans_common.rb +48 -0
  63. data/proto_docs/google/cloud/dataplex/v1/logs.rb +7 -3
  64. data/proto_docs/google/cloud/dataplex/v1/metadata.rb +10 -8
  65. data/proto_docs/google/cloud/dataplex/v1/processing.rb +15 -11
  66. data/proto_docs/google/cloud/dataplex/v1/service.rb +2 -2
  67. data/proto_docs/google/cloud/dataplex/v1/tasks.rb +3 -3
  68. metadata +18 -4
@@ -34,10 +34,8 @@ module Google
34
34
  # @!attribute [rw] row_filter
35
35
  # @return [::String]
36
36
  # Optional. A filter applied to all rows in a single DataScan job.
37
- # The filter needs to be a valid SQL expression for a [WHERE clause in
38
- # GoogleSQL
39
- # syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).
40
- #
37
+ # The filter needs to be a valid SQL expression for a WHERE clause in
38
+ # BigQuery standard SQL syntax.
41
39
  # Example: col1 >= 0 AND col2 < 10
42
40
  # @!attribute [rw] post_scan_actions
43
41
  # @return [::Google::Cloud::Dataplex::V1::DataProfileSpec::PostScanActions]
@@ -73,8 +71,6 @@ module Google
73
71
  # Optional. The BigQuery table to export DataProfileScan results to.
74
72
  # Format:
75
73
  # //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
76
- # or
77
- # projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
78
74
  class BigQueryExport
79
75
  include ::Google::Protobuf::MessageExts
80
76
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -99,15 +95,15 @@ module Google
99
95
 
100
96
  # DataProfileResult defines the output of DataProfileScan. Each field of the
101
97
  # table will have field type specific profile result.
102
- # @!attribute [rw] row_count
98
+ # @!attribute [r] row_count
103
99
  # @return [::Integer]
104
- # The count of rows scanned.
105
- # @!attribute [rw] profile
100
+ # Output only. The count of rows scanned.
101
+ # @!attribute [r] profile
106
102
  # @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile]
107
- # The profile information per field.
108
- # @!attribute [rw] scanned_data
103
+ # Output only. The profile information per field.
104
+ # @!attribute [r] scanned_data
109
105
  # @return [::Google::Cloud::Dataplex::V1::ScannedData]
110
- # The data scanned for this result.
106
+ # Output only. The data scanned for this result.
111
107
  # @!attribute [r] post_scan_actions_result
112
108
  # @return [::Google::Cloud::Dataplex::V1::DataProfileResult::PostScanActionsResult]
113
109
  # Output only. The result of post scan actions.
@@ -116,54 +112,58 @@ module Google
116
112
  extend ::Google::Protobuf::MessageExts::ClassMethods
117
113
 
118
114
  # Contains name, type, mode and field type specific profile information.
119
- # @!attribute [rw] fields
115
+ # @!attribute [r] fields
120
116
  # @return [::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field>]
121
- # List of fields with structural and profile information for each field.
117
+ # Output only. List of fields with structural and profile information for
118
+ # each field.
122
119
  class Profile
123
120
  include ::Google::Protobuf::MessageExts
124
121
  extend ::Google::Protobuf::MessageExts::ClassMethods
125
122
 
126
123
  # A field within a table.
127
- # @!attribute [rw] name
124
+ # @!attribute [r] name
128
125
  # @return [::String]
129
- # The name of the field.
130
- # @!attribute [rw] type
126
+ # Output only. The name of the field.
127
+ # @!attribute [r] type
131
128
  # @return [::String]
132
- # The data type retrieved from the schema of the data source. For
133
- # instance, for a BigQuery native table, it is the [BigQuery Table
129
+ # Output only. The data type retrieved from the schema of the data
130
+ # source. For instance, for a BigQuery native table, it is the [BigQuery
131
+ # Table
134
132
  # Schema](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablefieldschema).
135
- # For a Dataplex Entity, it is the [Entity
133
+ # For a Dataplex Universal Catalog Entity, it is the [Entity
136
134
  # Schema](https://cloud.google.com/dataplex/docs/reference/rpc/google.cloud.dataplex.v1#type_3).
137
- # @!attribute [rw] mode
135
+ # @!attribute [r] mode
138
136
  # @return [::String]
139
- # The mode of the field. Possible values include:
137
+ # Output only. The mode of the field. Possible values include:
140
138
  #
141
139
  # * REQUIRED, if it is a required field.
142
140
  # * NULLABLE, if it is an optional field.
143
141
  # * REPEATED, if it is a repeated field.
144
- # @!attribute [rw] profile
142
+ # @!attribute [r] profile
145
143
  # @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo]
146
- # Profile information for the corresponding field.
144
+ # Output only. Profile information for the corresponding field.
147
145
  class Field
148
146
  include ::Google::Protobuf::MessageExts
149
147
  extend ::Google::Protobuf::MessageExts::ClassMethods
150
148
 
151
149
  # The profile information for each field type.
152
- # @!attribute [rw] null_ratio
150
+ # @!attribute [r] null_ratio
153
151
  # @return [::Float]
154
- # Ratio of rows with null value against total scanned rows.
155
- # @!attribute [rw] distinct_ratio
152
+ # Output only. Ratio of rows with null value against total scanned
153
+ # rows.
154
+ # @!attribute [r] distinct_ratio
156
155
  # @return [::Float]
157
- # Ratio of rows with distinct values against total scanned rows.
158
- # Not available for complex non-groupable field type, including RECORD,
159
- # ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.
160
- # @!attribute [rw] top_n_values
156
+ # Output only. Ratio of rows with distinct values against total scanned
157
+ # rows. Not available for complex non-groupable field type, including
158
+ # RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE
159
+ # mode.
160
+ # @!attribute [r] top_n_values
161
161
  # @return [::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::TopNValue>]
162
- # The list of top N non-null values, frequency and ratio with which
163
- # they occur in the scanned data. N is 10 or equal to the number of
164
- # distinct values in the field, whichever is smaller. Not available for
165
- # complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY,
166
- # and JSON, as well as fields with REPEATABLE mode.
162
+ # Output only. The list of top N non-null values, frequency and ratio
163
+ # with which they occur in the scanned data. N is 10 or equal to the
164
+ # number of distinct values in the field, whichever is smaller. Not
165
+ # available for complex non-groupable field type, including RECORD,
166
+ # ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.
167
167
  # @!attribute [rw] string_profile
168
168
  # @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::StringFieldInfo]
169
169
  # String type field information.
@@ -184,102 +184,103 @@ module Google
184
184
  extend ::Google::Protobuf::MessageExts::ClassMethods
185
185
 
186
186
  # The profile information for a string type field.
187
- # @!attribute [rw] min_length
187
+ # @!attribute [r] min_length
188
188
  # @return [::Integer]
189
- # Minimum length of non-null values in the scanned data.
190
- # @!attribute [rw] max_length
189
+ # Output only. Minimum length of non-null values in the scanned data.
190
+ # @!attribute [r] max_length
191
191
  # @return [::Integer]
192
- # Maximum length of non-null values in the scanned data.
193
- # @!attribute [rw] average_length
192
+ # Output only. Maximum length of non-null values in the scanned data.
193
+ # @!attribute [r] average_length
194
194
  # @return [::Float]
195
- # Average length of non-null values in the scanned data.
195
+ # Output only. Average length of non-null values in the scanned data.
196
196
  class StringFieldInfo
197
197
  include ::Google::Protobuf::MessageExts
198
198
  extend ::Google::Protobuf::MessageExts::ClassMethods
199
199
  end
200
200
 
201
201
  # The profile information for an integer type field.
202
- # @!attribute [rw] average
202
+ # @!attribute [r] average
203
203
  # @return [::Float]
204
- # Average of non-null values in the scanned data. NaN, if the field
205
- # has a NaN.
206
- # @!attribute [rw] standard_deviation
204
+ # Output only. Average of non-null values in the scanned data. NaN,
205
+ # if the field has a NaN.
206
+ # @!attribute [r] standard_deviation
207
207
  # @return [::Float]
208
- # Standard deviation of non-null values in the scanned data. NaN, if
209
- # the field has a NaN.
210
- # @!attribute [rw] min
208
+ # Output only. Standard deviation of non-null values in the scanned
209
+ # data. NaN, if the field has a NaN.
210
+ # @!attribute [r] min
211
211
  # @return [::Integer]
212
- # Minimum of non-null values in the scanned data. NaN, if the field
213
- # has a NaN.
214
- # @!attribute [rw] quartiles
212
+ # Output only. Minimum of non-null values in the scanned data. NaN,
213
+ # if the field has a NaN.
214
+ # @!attribute [r] quartiles
215
215
  # @return [::Array<::Integer>]
216
- # A quartile divides the number of data points into four parts, or
217
- # quarters, of more-or-less equal size. Three main quartiles used
218
- # are: The first quartile (Q1) splits off the lowest 25% of data from
219
- # the highest 75%. It is also known as the lower or 25th empirical
220
- # quartile, as 25% of the data is below this point. The second
221
- # quartile (Q2) is the median of a data set. So, 50% of the data lies
222
- # below this point. The third quartile (Q3) splits off the highest
223
- # 25% of data from the lowest 75%. It is known as the upper or 75th
224
- # empirical quartile, as 75% of the data lies below this point.
225
- # Here, the quartiles is provided as an ordered list of approximate
226
- # quartile values for the scanned data, occurring in order Q1,
227
- # median, Q3.
228
- # @!attribute [rw] max
216
+ # Output only. A quartile divides the number of data points into four
217
+ # parts, or quarters, of more-or-less equal size. Three main
218
+ # quartiles used are: The first quartile (Q1) splits off the lowest
219
+ # 25% of data from the highest 75%. It is also known as the lower or
220
+ # 25th empirical quartile, as 25% of the data is below this point.
221
+ # The second quartile (Q2) is the median of a data set. So, 50% of
222
+ # the data lies below this point. The third quartile (Q3) splits off
223
+ # the highest 25% of data from the lowest 75%. It is known as the
224
+ # upper or 75th empirical quartile, as 75% of the data lies below
225
+ # this point. Here, the quartiles is provided as an ordered list of
226
+ # approximate quartile values for the scanned data, occurring in
227
+ # order Q1, median, Q3.
228
+ # @!attribute [r] max
229
229
  # @return [::Integer]
230
- # Maximum of non-null values in the scanned data. NaN, if the field
231
- # has a NaN.
230
+ # Output only. Maximum of non-null values in the scanned data. NaN,
231
+ # if the field has a NaN.
232
232
  class IntegerFieldInfo
233
233
  include ::Google::Protobuf::MessageExts
234
234
  extend ::Google::Protobuf::MessageExts::ClassMethods
235
235
  end
236
236
 
237
237
  # The profile information for a double type field.
238
- # @!attribute [rw] average
238
+ # @!attribute [r] average
239
239
  # @return [::Float]
240
- # Average of non-null values in the scanned data. NaN, if the field
241
- # has a NaN.
242
- # @!attribute [rw] standard_deviation
240
+ # Output only. Average of non-null values in the scanned data. NaN,
241
+ # if the field has a NaN.
242
+ # @!attribute [r] standard_deviation
243
243
  # @return [::Float]
244
- # Standard deviation of non-null values in the scanned data. NaN, if
245
- # the field has a NaN.
246
- # @!attribute [rw] min
244
+ # Output only. Standard deviation of non-null values in the scanned
245
+ # data. NaN, if the field has a NaN.
246
+ # @!attribute [r] min
247
247
  # @return [::Float]
248
- # Minimum of non-null values in the scanned data. NaN, if the field
249
- # has a NaN.
250
- # @!attribute [rw] quartiles
248
+ # Output only. Minimum of non-null values in the scanned data. NaN,
249
+ # if the field has a NaN.
250
+ # @!attribute [r] quartiles
251
251
  # @return [::Array<::Float>]
252
- # A quartile divides the number of data points into four parts, or
253
- # quarters, of more-or-less equal size. Three main quartiles used
254
- # are: The first quartile (Q1) splits off the lowest 25% of data from
255
- # the highest 75%. It is also known as the lower or 25th empirical
256
- # quartile, as 25% of the data is below this point. The second
257
- # quartile (Q2) is the median of a data set. So, 50% of the data lies
258
- # below this point. The third quartile (Q3) splits off the highest
259
- # 25% of data from the lowest 75%. It is known as the upper or 75th
260
- # empirical quartile, as 75% of the data lies below this point.
261
- # Here, the quartiles is provided as an ordered list of quartile
262
- # values for the scanned data, occurring in order Q1, median, Q3.
263
- # @!attribute [rw] max
252
+ # Output only. A quartile divides the number of data points into four
253
+ # parts, or quarters, of more-or-less equal size. Three main
254
+ # quartiles used are: The first quartile (Q1) splits off the lowest
255
+ # 25% of data from the highest 75%. It is also known as the lower or
256
+ # 25th empirical quartile, as 25% of the data is below this point.
257
+ # The second quartile (Q2) is the median of a data set. So, 50% of
258
+ # the data lies below this point. The third quartile (Q3) splits off
259
+ # the highest 25% of data from the lowest 75%. It is known as the
260
+ # upper or 75th empirical quartile, as 75% of the data lies below
261
+ # this point. Here, the quartiles is provided as an ordered list of
262
+ # quartile values for the scanned data, occurring in order Q1,
263
+ # median, Q3.
264
+ # @!attribute [r] max
264
265
  # @return [::Float]
265
- # Maximum of non-null values in the scanned data. NaN, if the field
266
- # has a NaN.
266
+ # Output only. Maximum of non-null values in the scanned data. NaN,
267
+ # if the field has a NaN.
267
268
  class DoubleFieldInfo
268
269
  include ::Google::Protobuf::MessageExts
269
270
  extend ::Google::Protobuf::MessageExts::ClassMethods
270
271
  end
271
272
 
272
273
  # Top N non-null values in the scanned data.
273
- # @!attribute [rw] value
274
+ # @!attribute [r] value
274
275
  # @return [::String]
275
- # String value of a top N non-null value.
276
- # @!attribute [rw] count
276
+ # Output only. String value of a top N non-null value.
277
+ # @!attribute [r] count
277
278
  # @return [::Integer]
278
- # Count of the corresponding value in the scanned data.
279
- # @!attribute [rw] ratio
279
+ # Output only. Count of the corresponding value in the scanned data.
280
+ # @!attribute [r] ratio
280
281
  # @return [::Float]
281
- # Ratio of the corresponding value in the field against the total
282
- # number of rows in the scanned data.
282
+ # Output only. Ratio of the corresponding value in the field against
283
+ # the total number of rows in the scanned data.
283
284
  class TopNValue
284
285
  include ::Google::Protobuf::MessageExts
285
286
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -46,6 +46,10 @@ module Google
46
46
  # @!attribute [rw] post_scan_actions
47
47
  # @return [::Google::Cloud::Dataplex::V1::DataQualitySpec::PostScanActions]
48
48
  # Optional. Actions to take upon job completion.
49
+ # @!attribute [rw] catalog_publishing_enabled
50
+ # @return [::Boolean]
51
+ # Optional. If set, the latest DataScan job result will be published as
52
+ # Dataplex Universal Catalog metadata.
49
53
  class DataQualitySpec
50
54
  include ::Google::Protobuf::MessageExts
51
55
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -164,6 +168,10 @@ module Google
164
168
  # @!attribute [r] post_scan_actions_result
165
169
  # @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult]
166
170
  # Output only. The result of post scan actions.
171
+ # @!attribute [r] catalog_publishing_status
172
+ # @return [::Google::Cloud::Dataplex::V1::DataScanCatalogPublishingStatus]
173
+ # Output only. The status of publishing the data scan as Dataplex Universal
174
+ # Catalog metadata.
167
175
  class DataQualityResult
168
176
  include ::Google::Protobuf::MessageExts
169
177
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -280,9 +288,9 @@ module Google
280
288
 
281
289
  # A dimension captures data quality intent about a defined subset of the rules
282
290
  # specified.
283
- # @!attribute [rw] name
291
+ # @!attribute [r] name
284
292
  # @return [::String]
285
- # Optional. The dimension name a rule belongs to. Custom dimension name is
293
+ # Output only. The dimension name a rule belongs to. Custom dimension name is
286
294
  # supported with all uppercase letters and maximum length of 30 characters.
287
295
  class DataQualityDimension
288
296
  include ::Google::Protobuf::MessageExts
@@ -360,9 +368,8 @@ module Google
360
368
  # @!attribute [rw] dimension
361
369
  # @return [::String]
362
370
  # Required. The dimension a rule belongs to. Results are also aggregated at
363
- # the dimension level. Supported dimensions are **["COMPLETENESS",
364
- # "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS",
365
- # "VOLUME"]**
371
+ # the dimension level. Custom dimension name is supported with all uppercase
372
+ # letters and maximum length of 30 characters.
366
373
  # @!attribute [rw] threshold
367
374
  # @return [::Float]
368
375
  # Optional. The minimum ratio of **passing_rows / total_rows** required to
@@ -565,6 +572,12 @@ module Google
565
572
  #
566
573
  # The score ranges between between [0, 100] (up to two decimal
567
574
  # points).
575
+ # @!attribute [r] passed
576
+ # @return [::Boolean]
577
+ # Output only. Whether the column passed or failed.
578
+ # @!attribute [r] dimensions
579
+ # @return [::Array<::Google::Cloud::Dataplex::V1::DataQualityDimensionResult>]
580
+ # Output only. The dimension-level results for this column.
568
581
  class DataQualityColumnResult
569
582
  include ::Google::Protobuf::MessageExts
570
583
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -283,7 +283,7 @@ module Google
283
283
  # @return [::String]
284
284
  # Required. The resource name of the DataTaxonomy location, of the form:
285
285
  # projects/\\{project_number}/locations/\\{location_id}
286
- # where `location_id` refers to a GCP region.
286
+ # where `location_id` refers to a Google Cloud region.
287
287
  # @!attribute [rw] page_size
288
288
  # @return [::Integer]
289
289
  # Optional. Maximum number of DataTaxonomies to return. The service may
@@ -27,7 +27,7 @@ module Google
27
27
  # Required. The resource name of the parent location:
28
28
  # `projects/{project}/locations/{location_id}`
29
29
  # where `project` refers to a *project_id* or *project_number* and
30
- # `location_id` refers to a GCP region.
30
+ # `location_id` refers to a Google Cloud region.
31
31
  # @!attribute [rw] data_scan
32
32
  # @return [::Google::Cloud::Dataplex::V1::DataScan]
33
33
  # Required. DataScan resource.
@@ -73,7 +73,7 @@ module Google
73
73
  # Required. The resource name of the dataScan:
74
74
  # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
75
75
  # where `project` refers to a *project_id* or *project_number* and
76
- # `location_id` refers to a GCP region.
76
+ # `location_id` refers to a Google Cloud region.
77
77
  # @!attribute [rw] force
78
78
  # @return [::Boolean]
79
79
  # Optional. If set to true, any child resources of this data scan will also
@@ -90,7 +90,7 @@ module Google
90
90
  # Required. The resource name of the dataScan:
91
91
  # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
92
92
  # where `project` refers to a *project_id* or *project_number* and
93
- # `location_id` refers to a GCP region.
93
+ # `location_id` refers to a Google Cloud region.
94
94
  # @!attribute [rw] view
95
95
  # @return [::Google::Cloud::Dataplex::V1::GetDataScanRequest::DataScanView]
96
96
  # Optional. Select the DataScan view to return. Defaults to `BASIC`.
@@ -117,7 +117,7 @@ module Google
117
117
  # Required. The resource name of the parent location:
118
118
  # `projects/{project}/locations/{location_id}`
119
119
  # where `project` refers to a *project_id* or *project_number* and
120
- # `location_id` refers to a GCP region.
120
+ # `location_id` refers to a Google Cloud region.
121
121
  # @!attribute [rw] page_size
122
122
  # @return [::Integer]
123
123
  # Optional. Maximum number of dataScans to return. The service may return
@@ -163,7 +163,7 @@ module Google
163
163
  # Required. The resource name of the DataScan:
164
164
  # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`.
165
165
  # where `project` refers to a *project_id* or *project_number* and
166
- # `location_id` refers to a GCP region.
166
+ # `location_id` refers to a Google Cloud region.
167
167
  #
168
168
  # Only **OnDemand** data scans are allowed.
169
169
  class RunDataScanRequest
@@ -186,7 +186,7 @@ module Google
186
186
  # Required. The resource name of the DataScanJob:
187
187
  # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}`
188
188
  # where `project` refers to a *project_id* or *project_number* and
189
- # `location_id` refers to a GCP region.
189
+ # `location_id` refers to a Google Cloud region.
190
190
  # @!attribute [rw] view
191
191
  # @return [::Google::Cloud::Dataplex::V1::GetDataScanJobRequest::DataScanJobView]
192
192
  # Optional. Select the DataScanJob view to return. Defaults to `BASIC`.
@@ -213,7 +213,7 @@ module Google
213
213
  # Required. The resource name of the parent environment:
214
214
  # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
215
215
  # where `project` refers to a *project_id* or *project_number* and
216
- # `location_id` refers to a GCP region.
216
+ # `location_id` refers to a Google Cloud region.
217
217
  # @!attribute [rw] page_size
218
218
  # @return [::Integer]
219
219
  # Optional. Maximum number of DataScanJobs to return. The service may return
@@ -280,8 +280,8 @@ module Google
280
280
  # Response details for data quality rule recommendations.
281
281
  # @!attribute [rw] rule
282
282
  # @return [::Array<::Google::Cloud::Dataplex::V1::DataQualityRule>]
283
- # The data quality rules that Dataplex generates based on the results
284
- # of a data profiling scan.
283
+ # The data quality rules that Dataplex Universal Catalog generates based on
284
+ # the results of a data profiling scan.
285
285
  class GenerateDataQualityRulesResponse
286
286
  include ::Google::Protobuf::MessageExts
287
287
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -308,7 +308,7 @@ module Google
308
308
  # Output only. Identifier. The relative resource name of the scan, of the
309
309
  # form: `projects/{project}/locations/{location_id}/dataScans/{datascan_id}`,
310
310
  # where `project` refers to a *project_id* or *project_number* and
311
- # `location_id` refers to a GCP region.
311
+ # `location_id` refers to a Google Cloud region.
312
312
  # @!attribute [r] uid
313
313
  # @return [::String]
314
314
  # Output only. System generated globally unique ID for the scan. This ID will
@@ -433,7 +433,7 @@ module Google
433
433
  # the form:
434
434
  # `projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}`,
435
435
  # where `project` refers to a *project_id* or *project_number* and
436
- # `location_id` refers to a GCP region.
436
+ # `location_id` refers to a Google Cloud region.
437
437
  # @!attribute [r] uid
438
438
  # @return [::String]
439
439
  # Output only. System generated globally unique ID for the DataScanJob.
@@ -0,0 +1,48 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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
+ # The status of publishing the data scan result as Dataplex Universal Catalog
25
+ # metadata.
26
+ # @!attribute [r] state
27
+ # @return [::Google::Cloud::Dataplex::V1::DataScanCatalogPublishingStatus::State]
28
+ # Output only. Execution state for catalog publishing.
29
+ class DataScanCatalogPublishingStatus
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
+
33
+ # Execution state for the publishing.
34
+ module State
35
+ # The publishing state is unspecified.
36
+ STATE_UNSPECIFIED = 0
37
+
38
+ # Publish to catalog completed successfully.
39
+ SUCCEEDED = 1
40
+
41
+ # Publish to catalog failed.
42
+ FAILED = 2
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -299,8 +299,8 @@ module Google
299
299
  # The job execution trigger is unspecified.
300
300
  EXECUTION_TRIGGER_UNSPECIFIED = 0
301
301
 
302
- # The job was triggered by Dataplex based on trigger spec from task
303
- # definition.
302
+ # The job was triggered by Dataplex Universal Catalog based on trigger spec
303
+ # from task definition.
304
304
  TASK_CONFIG = 1
305
305
 
306
306
  # The job was triggered by the explicit call of Task API.
@@ -550,6 +550,10 @@ module Google
550
550
  # @!attribute [rw] post_scan_actions_result
551
551
  # @return [::Google::Cloud::Dataplex::V1::DataScanEvent::PostScanActionsResult]
552
552
  # The result of post scan actions.
553
+ # @!attribute [rw] catalog_publishing_status
554
+ # @return [::Google::Cloud::Dataplex::V1::DataScanCatalogPublishingStatus]
555
+ # The status of publishing the data scan as Dataplex Universal Catalog
556
+ # metadata.
553
557
  class DataScanEvent
554
558
  include ::Google::Protobuf::MessageExts
555
559
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -733,7 +737,7 @@ module Google
733
737
  # Data scan job was cancelled.
734
738
  CANCELLED = 4
735
739
 
736
- # Data scan job was createed.
740
+ # Data scan job was created.
737
741
  CREATED = 5
738
742
  end
739
743
 
@@ -407,18 +407,20 @@ module Google
407
407
  # Schema information describing the structure and layout of the data.
408
408
  # @!attribute [rw] user_managed
409
409
  # @return [::Boolean]
410
- # Required. Set to `true` if user-managed or `false` if managed by Dataplex.
411
- # The default is `false` (managed by Dataplex).
410
+ # Required. Set to `true` if user-managed or `false` if managed by Dataplex
411
+ # Universal Catalog. The default is `false` (managed by Dataplex Universal
412
+ # Catalog).
412
413
  #
413
- # - Set to `false`to enable Dataplex discovery to update the schema.
414
+ # - Set to `false`to enable Dataplex Universal Catalog discovery to update
415
+ # the schema.
414
416
  # including new data discovery, schema inference, and schema evolution.
415
- # Users retain the ability to input and edit the schema. Dataplex
416
- # treats schema input by the user as though produced
417
- # by a previous Dataplex discovery operation, and it will
418
- # evolve the schema and take action based on that treatment.
417
+ # Users retain the ability to input and edit the schema. Dataplex Universal
418
+ # Catalog treats schema input by the user as though produced by a previous
419
+ # Dataplex Universal Catalog discovery operation, and it will evolve the
420
+ # schema and take action based on that treatment.
419
421
  #
420
422
  # - Set to `true` to fully manage the entity
421
- # schema. This setting guarantees that Dataplex will not
423
+ # schema. This setting guarantees that Dataplex Universal Catalog will not
422
424
  # change schema fields.
423
425
  # @!attribute [rw] fields
424
426
  # @return [::Array<::Google::Cloud::Dataplex::V1::Schema::SchemaField>]
@@ -66,16 +66,20 @@ module Google
66
66
  # The data source for DataScan.
67
67
  # @!attribute [rw] entity
68
68
  # @return [::String]
69
- # Immutable. The Dataplex entity that represents the data source (e.g.
70
- # BigQuery table) for DataScan, of the form:
69
+ # Immutable. The Dataplex Universal Catalog entity that represents the data
70
+ # source (e.g. BigQuery table) for DataScan, of the form:
71
71
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
72
72
  #
73
73
  # Note: The following fields are mutually exclusive: `entity`, `resource`. If a field in that set is populated, all other fields in the set will automatically be cleared.
74
74
  # @!attribute [rw] resource
75
75
  # @return [::String]
76
76
  # Immutable. The service-qualified full resource name of the cloud resource
77
- # for a DataScan job to scan against. The field could be: BigQuery table of
78
- # type "TABLE" for DataProfileScan/DataQualityScan Format:
77
+ # for a DataScan job to scan against. The field could either be: Cloud
78
+ # Storage bucket for DataDiscoveryScan Format:
79
+ # //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID
80
+ # or
81
+ # BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan
82
+ # Format:
79
83
  # //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
80
84
  #
81
85
  # Note: The following fields are mutually exclusive: `resource`, `entity`. If a field in that set is populated, all other fields in the set will automatically be cleared.
@@ -93,16 +97,16 @@ module Google
93
97
  extend ::Google::Protobuf::MessageExts::ClassMethods
94
98
 
95
99
  # A data range denoted by a pair of start/end values of a field.
96
- # @!attribute [rw] field
100
+ # @!attribute [r] field
97
101
  # @return [::String]
98
- # The field that contains values which monotonically increases over time
99
- # (e.g. a timestamp column).
100
- # @!attribute [rw] start
102
+ # Output only. The field that contains values which monotonically increases
103
+ # over time (e.g. a timestamp column).
104
+ # @!attribute [r] start
101
105
  # @return [::String]
102
- # Value that marks the start of the range.
103
- # @!attribute [rw] end
106
+ # Output only. Value that marks the start of the range.
107
+ # @!attribute [r] end
104
108
  # @return [::String]
105
- # Value that marks the end of the range.
109
+ # Output only. Value that marks the end of the range.
106
110
  class IncrementalField
107
111
  include ::Google::Protobuf::MessageExts
108
112
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -26,7 +26,7 @@ module Google
26
26
  # @return [::String]
27
27
  # Required. The resource name of the lake location, of the form:
28
28
  # projects/\\{project_number}/locations/\\{location_id}
29
- # where `location_id` refers to a GCP region.
29
+ # where `location_id` refers to a Google Cloud region.
30
30
  # @!attribute [rw] lake_id
31
31
  # @return [::String]
32
32
  # Required. Lake identifier.
@@ -81,7 +81,7 @@ module Google
81
81
  # @return [::String]
82
82
  # Required. The resource name of the lake location, of the form:
83
83
  # `projects/{project_number}/locations/{location_id}`
84
- # where `location_id` refers to a GCP region.
84
+ # where `location_id` refers to a Google Cloud region.
85
85
  # @!attribute [rw] page_size
86
86
  # @return [::Integer]
87
87
  # Optional. Maximum number of Lakes to return. The service may return fewer