google-cloud-dataplex-v1 2.1.0 → 2.3.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 (38) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/dataplex/v1/catalog_pb.rb +4 -1
  3. data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +1 -11
  4. data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +14 -0
  5. data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +1 -11
  6. data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +1 -11
  7. data/lib/google/cloud/dataplex/v1/cmek_pb.rb +63 -0
  8. data/lib/google/cloud/dataplex/v1/cmek_service/client.rb +947 -0
  9. data/lib/google/cloud/dataplex/v1/cmek_service/credentials.rb +47 -0
  10. data/lib/google/cloud/dataplex/v1/cmek_service/operations.rb +813 -0
  11. data/lib/google/cloud/dataplex/v1/cmek_service/paths.rb +69 -0
  12. data/lib/google/cloud/dataplex/v1/cmek_service/rest/client.rb +895 -0
  13. data/lib/google/cloud/dataplex/v1/cmek_service/rest/operations.rb +943 -0
  14. data/lib/google/cloud/dataplex/v1/cmek_service/rest/service_stub.rb +388 -0
  15. data/lib/google/cloud/dataplex/v1/cmek_service/rest.rb +54 -0
  16. data/lib/google/cloud/dataplex/v1/cmek_service.rb +56 -0
  17. data/lib/google/cloud/dataplex/v1/cmek_services_pb.rb +53 -0
  18. data/lib/google/cloud/dataplex/v1/data_discovery_pb.rb +2 -1
  19. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +1 -1
  20. data/lib/google/cloud/dataplex/v1/data_taxonomy_pb.rb +1 -1
  21. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/client.rb +32 -5
  22. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/client.rb +1 -5
  23. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/service_stub.rb +1 -0
  24. data/lib/google/cloud/dataplex/v1/data_taxonomy_service.rb +2 -0
  25. data/lib/google/cloud/dataplex/v1/logs_pb.rb +5 -1
  26. data/lib/google/cloud/dataplex/v1/rest.rb +1 -0
  27. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  28. data/lib/google/cloud/dataplex/v1.rb +1 -0
  29. data/proto_docs/google/api/client.rb +6 -0
  30. data/proto_docs/google/cloud/dataplex/v1/catalog.rb +133 -22
  31. data/proto_docs/google/cloud/dataplex/v1/cmek.rb +216 -0
  32. data/proto_docs/google/cloud/dataplex/v1/data_discovery.rb +63 -3
  33. data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +6 -2
  34. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +46 -36
  35. data/proto_docs/google/cloud/dataplex/v1/data_taxonomy.rb +7 -5
  36. data/proto_docs/google/cloud/dataplex/v1/logs.rb +75 -0
  37. data/proto_docs/google/cloud/dataplex/v1/resources.rb +14 -10
  38. metadata +15 -3
@@ -38,8 +38,10 @@ module Google
38
38
  # @!attribute [rw] row_filter
39
39
  # @return [::String]
40
40
  # Optional. A filter applied to all rows in a single DataScan job.
41
- # The filter needs to be a valid SQL expression for a WHERE clause in
42
- # BigQuery standard SQL syntax.
41
+ # The filter needs to be a valid SQL expression for a [WHERE clause in
42
+ # GoogleSQL
43
+ # syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).
44
+ #
43
45
  # Example: col1 >= 0 AND col2 < 10
44
46
  # @!attribute [rw] post_scan_actions
45
47
  # @return [::Google::Cloud::Dataplex::V1::DataQualitySpec::PostScanActions]
@@ -67,6 +69,8 @@ module Google
67
69
  # Optional. The BigQuery table to export DataQualityScan results to.
68
70
  # Format:
69
71
  # //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
72
+ # or
73
+ # projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
70
74
  class BigQueryExport
71
75
  include ::Google::Protobuf::MessageExts
72
76
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -128,17 +132,17 @@ module Google
128
132
  end
129
133
 
130
134
  # The output of a DataQualityScan.
131
- # @!attribute [rw] passed
135
+ # @!attribute [r] passed
132
136
  # @return [::Boolean]
133
- # Overall data quality result -- `true` if all rules passed.
137
+ # Output only. Overall data quality result -- `true` if all rules passed.
134
138
  # @!attribute [r] score
135
139
  # @return [::Float]
136
140
  # Output only. The overall data quality score.
137
141
  #
138
142
  # The score ranges between [0, 100] (up to two decimal points).
139
- # @!attribute [rw] dimensions
143
+ # @!attribute [r] dimensions
140
144
  # @return [::Array<::Google::Cloud::Dataplex::V1::DataQualityDimensionResult>]
141
- # A list of results at the dimension level.
145
+ # Output only. A list of results at the dimension level.
142
146
  #
143
147
  # A dimension will have a corresponding `DataQualityDimensionResult` if and
144
148
  # only if there is at least one rule with the 'dimension' field set to it.
@@ -148,15 +152,15 @@ module Google
148
152
  #
149
153
  # A column will have a corresponding `DataQualityColumnResult` if and only if
150
154
  # there is at least one rule with the 'column' field set to it.
151
- # @!attribute [rw] rules
155
+ # @!attribute [r] rules
152
156
  # @return [::Array<::Google::Cloud::Dataplex::V1::DataQualityRuleResult>]
153
- # A list of all the rules in a job, and their results.
154
- # @!attribute [rw] row_count
157
+ # Output only. A list of all the rules in a job, and their results.
158
+ # @!attribute [r] row_count
155
159
  # @return [::Integer]
156
- # The count of rows processed.
157
- # @!attribute [rw] scanned_data
160
+ # Output only. The count of rows processed.
161
+ # @!attribute [r] scanned_data
158
162
  # @return [::Google::Cloud::Dataplex::V1::ScannedData]
159
- # The data scanned for this result.
163
+ # Output only. The data scanned for this result.
160
164
  # @!attribute [r] post_scan_actions_result
161
165
  # @return [::Google::Cloud::Dataplex::V1::DataQualityResult::PostScanActionsResult]
162
166
  # Output only. The result of post scan actions.
@@ -203,15 +207,15 @@ module Google
203
207
  end
204
208
 
205
209
  # DataQualityRuleResult provides a more detailed, per-rule view of the results.
206
- # @!attribute [rw] rule
210
+ # @!attribute [r] rule
207
211
  # @return [::Google::Cloud::Dataplex::V1::DataQualityRule]
208
- # The rule specified in the DataQualitySpec, as is.
209
- # @!attribute [rw] passed
212
+ # Output only. The rule specified in the DataQualitySpec, as is.
213
+ # @!attribute [r] passed
210
214
  # @return [::Boolean]
211
- # Whether the rule passed or failed.
212
- # @!attribute [rw] evaluated_count
215
+ # Output only. Whether the rule passed or failed.
216
+ # @!attribute [r] evaluated_count
213
217
  # @return [::Integer]
214
- # The number of rows a rule was evaluated against.
218
+ # Output only. The number of rows a rule was evaluated against.
215
219
  #
216
220
  # This field is only valid for row-level type rules.
217
221
  #
@@ -223,20 +227,24 @@ module Google
223
227
  # `ignore_nulls = true`.
224
228
  #
225
229
  # This field is not set for rule SqlAssertion.
226
- # @!attribute [rw] passed_count
230
+ # @!attribute [r] passed_count
227
231
  # @return [::Integer]
232
+ # Output only. The number of rows which passed a rule evaluation.
233
+ #
234
+ # This field is only valid for row-level type rules.
235
+ #
228
236
  # This field is not set for rule SqlAssertion.
229
- # @!attribute [rw] null_count
237
+ # @!attribute [r] null_count
230
238
  # @return [::Integer]
231
- # The number of rows with null values in the specified column.
232
- # @!attribute [rw] pass_ratio
239
+ # Output only. The number of rows with null values in the specified column.
240
+ # @!attribute [r] pass_ratio
233
241
  # @return [::Float]
234
- # The ratio of **passed_count / evaluated_count**.
242
+ # Output only. The ratio of **passed_count / evaluated_count**.
235
243
  #
236
244
  # This field is only valid for row-level type rules.
237
- # @!attribute [rw] failing_rows_query
245
+ # @!attribute [r] failing_rows_query
238
246
  # @return [::String]
239
- # The query to find rows that did not pass this rule.
247
+ # Output only. The query to find rows that did not pass this rule.
240
248
  #
241
249
  # This field is only valid for row-level type rules.
242
250
  # @!attribute [r] assertion_row_count
@@ -255,9 +263,9 @@ module Google
255
263
  # @!attribute [r] dimension
256
264
  # @return [::Google::Cloud::Dataplex::V1::DataQualityDimension]
257
265
  # Output only. The dimension config specified in the DataQualitySpec, as is.
258
- # @!attribute [rw] passed
266
+ # @!attribute [r] passed
259
267
  # @return [::Boolean]
260
- # Whether the dimension passed or failed.
268
+ # Output only. Whether the dimension passed or failed.
261
269
  # @!attribute [r] score
262
270
  # @return [::Float]
263
271
  # Output only. The dimension-level data quality score for this data scan job
@@ -274,9 +282,8 @@ module Google
274
282
  # specified.
275
283
  # @!attribute [rw] name
276
284
  # @return [::String]
277
- # The dimension name a rule belongs to. Supported dimensions are
278
- # ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS",
279
- # "FRESHNESS", "VOLUME"]
285
+ # Optional. The dimension name a rule belongs to. Custom dimension name is
286
+ # supported with all uppercase letters and maximum length of 30 characters.
280
287
  class DataQualityDimension
281
288
  include ::Google::Protobuf::MessageExts
282
289
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -495,8 +502,9 @@ module Google
495
502
 
496
503
  # Evaluates whether each row passes the specified condition.
497
504
  #
498
- # The SQL expression needs to use BigQuery standard SQL syntax and should
499
- # produce a boolean value per row as the result.
505
+ # The SQL expression needs to use [GoogleSQL
506
+ # syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax)
507
+ # and should produce a boolean value per row as the result.
500
508
  #
501
509
  # Example: col1 >= 0 AND col2 < 10
502
510
  # @!attribute [rw] sql_expression
@@ -509,8 +517,9 @@ module Google
509
517
 
510
518
  # Evaluates whether the provided expression is true.
511
519
  #
512
- # The SQL expression needs to use BigQuery standard SQL syntax and should
513
- # produce a scalar boolean result.
520
+ # The SQL expression needs to use [GoogleSQL
521
+ # syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax)
522
+ # and should produce a scalar boolean result.
514
523
  #
515
524
  # Example: MIN(col1) >= 0
516
525
  # @!attribute [rw] sql_expression
@@ -524,8 +533,9 @@ module Google
524
533
  # A SQL statement that is evaluated to return rows that match an invalid
525
534
  # state. If any rows are are returned, this rule fails.
526
535
  #
527
- # The SQL statement must use BigQuery standard SQL syntax, and must not
528
- # contain any semicolons.
536
+ # The SQL statement must use [GoogleSQL
537
+ # syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax),
538
+ # and must not contain any semicolons.
529
539
  #
530
540
  # You can use the data reference parameter `${data()}` to reference the
531
541
  # source table with all of its precondition filters applied. Examples of
@@ -24,6 +24,7 @@ module Google
24
24
  # DataTaxonomy represents a set of hierarchical DataAttributes resources,
25
25
  # grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes
26
26
  # to manage PII data. It is defined at project level.
27
+ # @deprecated This message is deprecated and may be removed in the next major version update.
27
28
  # @!attribute [r] name
28
29
  # @return [::String]
29
30
  # Output only. The relative resource name of the DataTaxonomy, of the form:
@@ -84,6 +85,7 @@ module Google
84
85
  # - DataAccessSpec :
85
86
  # - readers :bar@foo.com
86
87
  # ```
88
+ # @deprecated This message is deprecated and may be removed in the next major version update.
87
89
  # @!attribute [r] name
88
90
  # @return [::String]
89
91
  # Output only. The relative resource name of the dataAttribute, of the form:
@@ -146,6 +148,7 @@ module Google
146
148
 
147
149
  # DataAttributeBinding represents binding of attributes to resources. Eg: Bind
148
150
  # 'CustomerInfo' entity with 'PII' attribute.
151
+ # @deprecated This message is deprecated and may be removed in the next major version update.
149
152
  # @!attribute [r] name
150
153
  # @return [::String]
151
154
  # Output only. The relative resource name of the Data Attribute Binding, of
@@ -226,11 +229,9 @@ module Google
226
229
  end
227
230
 
228
231
  # Create DataTaxonomy request.
232
+ # @deprecated This message is deprecated and may be removed in the next major version update.
229
233
  # @!attribute [rw] parent
230
234
  # @return [::String]
231
- # Required. The resource name of the data taxonomy location, of the form:
232
- # projects/\\{project_number}/locations/\\{location_id}
233
- # where `location_id` refers to a GCP region.
234
235
  # @!attribute [rw] data_taxonomy_id
235
236
  # @return [::String]
236
237
  # Required. DataTaxonomy identifier.
@@ -252,6 +253,7 @@ module Google
252
253
  end
253
254
 
254
255
  # Update DataTaxonomy request.
256
+ # @deprecated This message is deprecated and may be removed in the next major version update.
255
257
  # @!attribute [rw] update_mask
256
258
  # @return [::Google::Protobuf::FieldMask]
257
259
  # Required. Mask of fields to update.
@@ -268,10 +270,9 @@ module Google
268
270
  end
269
271
 
270
272
  # Get DataTaxonomy request.
273
+ # @deprecated This message is deprecated and may be removed in the next major version update.
271
274
  # @!attribute [rw] name
272
275
  # @return [::String]
273
- # Required. The resource name of the DataTaxonomy:
274
- # projects/\\{project_number}/locations/\\{location_id}/dataTaxonomies/\\{data_taxonomy_id}
275
276
  class GetDataTaxonomyRequest
276
277
  include ::Google::Protobuf::MessageExts
277
278
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -323,6 +324,7 @@ module Google
323
324
  end
324
325
 
325
326
  # Delete DataTaxonomy request.
327
+ # @deprecated This message is deprecated and may be removed in the next major version update.
326
328
  # @!attribute [rw] name
327
329
  # @return [::String]
328
330
  # Required. The resource name of the DataTaxonomy:
@@ -876,6 +876,81 @@ module Google
876
876
  FAILED = 2
877
877
  end
878
878
  end
879
+
880
+ # Payload associated with Business Glossary related log events.
881
+ # @!attribute [rw] message
882
+ # @return [::String]
883
+ # The log message.
884
+ # @!attribute [rw] event_type
885
+ # @return [::Google::Cloud::Dataplex::V1::BusinessGlossaryEvent::EventType]
886
+ # The type of the event.
887
+ # @!attribute [rw] resource
888
+ # @return [::String]
889
+ # Name of the resource.
890
+ class BusinessGlossaryEvent
891
+ include ::Google::Protobuf::MessageExts
892
+ extend ::Google::Protobuf::MessageExts::ClassMethods
893
+
894
+ # Type of glossary log event.
895
+ module EventType
896
+ # An unspecified event type.
897
+ EVENT_TYPE_UNSPECIFIED = 0
898
+
899
+ # Glossary create event.
900
+ GLOSSARY_CREATE = 1
901
+
902
+ # Glossary update event.
903
+ GLOSSARY_UPDATE = 2
904
+
905
+ # Glossary delete event.
906
+ GLOSSARY_DELETE = 3
907
+
908
+ # Glossary category create event.
909
+ GLOSSARY_CATEGORY_CREATE = 4
910
+
911
+ # Glossary category update event.
912
+ GLOSSARY_CATEGORY_UPDATE = 5
913
+
914
+ # Glossary category delete event.
915
+ GLOSSARY_CATEGORY_DELETE = 6
916
+
917
+ # Glossary term create event.
918
+ GLOSSARY_TERM_CREATE = 7
919
+
920
+ # Glossary term update event.
921
+ GLOSSARY_TERM_UPDATE = 8
922
+
923
+ # Glossary term delete event.
924
+ GLOSSARY_TERM_DELETE = 9
925
+ end
926
+ end
927
+
928
+ # Payload associated with Entry related log events.
929
+ # @!attribute [rw] message
930
+ # @return [::String]
931
+ # The log message.
932
+ # @!attribute [rw] event_type
933
+ # @return [::Google::Cloud::Dataplex::V1::EntryLinkEvent::EventType]
934
+ # The type of the event.
935
+ # @!attribute [rw] resource
936
+ # @return [::String]
937
+ # Name of the resource.
938
+ class EntryLinkEvent
939
+ include ::Google::Protobuf::MessageExts
940
+ extend ::Google::Protobuf::MessageExts::ClassMethods
941
+
942
+ # Type of entry link log event.
943
+ module EventType
944
+ # An unspecified event type.
945
+ EVENT_TYPE_UNSPECIFIED = 0
946
+
947
+ # EntryLink create event.
948
+ ENTRY_LINK_CREATE = 1
949
+
950
+ # EntryLink delete event.
951
+ ENTRY_LINK_DELETE = 2
952
+ end
953
+ end
879
954
  end
880
955
  end
881
956
  end
@@ -246,11 +246,13 @@ module Google
246
246
  # Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
247
247
  # running discovery periodically. Successive discovery runs must be
248
248
  # scheduled at least 60 minutes apart. The default value is to run
249
- # discovery every 60 minutes. To explicitly set a timezone to the cron
250
- # tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
251
- # TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
252
- # from IANA time zone database. For example, `CRON_TZ=America/New_York 1
253
- # * * * *`, or `TZ=America/New_York 1 * * * *`.
249
+ # discovery every 60 minutes.
250
+ #
251
+ # To explicitly set a timezone to the cron tab, apply a prefix in the
252
+ # cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or TZ=$\\{IANA_TIME_ZONE}".
253
+ # The $\\{IANA_TIME_ZONE} may only be a valid string from IANA time zone
254
+ # database. For example, `CRON_TZ=America/New_York 1 * * * *`, or
255
+ # `TZ=America/New_York 1 * * * *`.
254
256
  class DiscoverySpec
255
257
  include ::Google::Protobuf::MessageExts
256
258
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -641,11 +643,13 @@ module Google
641
643
  # Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
642
644
  # running discovery periodically. Successive discovery runs must be
643
645
  # scheduled at least 60 minutes apart. The default value is to run
644
- # discovery every 60 minutes. To explicitly set a timezone to the cron
645
- # tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
646
- # TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
647
- # from IANA time zone database. For example, `CRON_TZ=America/New_York 1
648
- # * * * *`, or `TZ=America/New_York 1 * * * *`.
646
+ # discovery every 60 minutes.
647
+ #
648
+ # To explicitly set a timezone to the cron tab, apply a prefix in the
649
+ # cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or TZ=$\\{IANA_TIME_ZONE}".
650
+ # The $\\{IANA_TIME_ZONE} may only be a valid string from IANA time zone
651
+ # database. For example, `CRON_TZ=America/New_York 1 * * * *`, or
652
+ # `TZ=America/New_York 1 * * * *`.
649
653
  class DiscoverySpec
650
654
  include ::Google::Protobuf::MessageExts
651
655
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dataplex-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.1.0
4
+ version: 2.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-02-07 00:00:00.000000000 Z
10
+ date: 2025-04-21 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: gapic-common
@@ -113,6 +113,17 @@ files:
113
113
  - lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb
114
114
  - lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb
115
115
  - lib/google/cloud/dataplex/v1/catalog_services_pb.rb
116
+ - lib/google/cloud/dataplex/v1/cmek_pb.rb
117
+ - lib/google/cloud/dataplex/v1/cmek_service.rb
118
+ - lib/google/cloud/dataplex/v1/cmek_service/client.rb
119
+ - lib/google/cloud/dataplex/v1/cmek_service/credentials.rb
120
+ - lib/google/cloud/dataplex/v1/cmek_service/operations.rb
121
+ - lib/google/cloud/dataplex/v1/cmek_service/paths.rb
122
+ - lib/google/cloud/dataplex/v1/cmek_service/rest.rb
123
+ - lib/google/cloud/dataplex/v1/cmek_service/rest/client.rb
124
+ - lib/google/cloud/dataplex/v1/cmek_service/rest/operations.rb
125
+ - lib/google/cloud/dataplex/v1/cmek_service/rest/service_stub.rb
126
+ - lib/google/cloud/dataplex/v1/cmek_services_pb.rb
116
127
  - lib/google/cloud/dataplex/v1/content_pb.rb
117
128
  - lib/google/cloud/dataplex/v1/content_service.rb
118
129
  - lib/google/cloud/dataplex/v1/content_service/client.rb
@@ -182,6 +193,7 @@ files:
182
193
  - proto_docs/google/api/resource.rb
183
194
  - proto_docs/google/cloud/dataplex/v1/analyze.rb
184
195
  - proto_docs/google/cloud/dataplex/v1/catalog.rb
196
+ - proto_docs/google/cloud/dataplex/v1/cmek.rb
185
197
  - proto_docs/google/cloud/dataplex/v1/content.rb
186
198
  - proto_docs/google/cloud/dataplex/v1/data_discovery.rb
187
199
  - proto_docs/google/cloud/dataplex/v1/data_profile.rb
@@ -222,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
222
234
  - !ruby/object:Gem::Version
223
235
  version: '0'
224
236
  requirements: []
225
- rubygems_version: 3.6.3
237
+ rubygems_version: 3.6.5
226
238
  specification_version: 4
227
239
  summary: Dataplex API is used to manage the lifecycle of data lakes.
228
240
  test_files: []