google-cloud-dataplex-v1 0.6.0 → 0.6.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 37663d721c07fab480e9d524935fff4ca249840150b38029e071d481c48b14df
4
- data.tar.gz: 70ffa1fd85415d48e175232fa6668cde2ceb76a2520e3d17eea0e50ff75e4461
3
+ metadata.gz: db9919f82c0cfe70b77f610aea3eb22fe6c3d897818cf8c3ab4aa53ad2d2f2fe
4
+ data.tar.gz: 5c926aefa9e9220b129a30174636b497857521ebf8b03f65e66852692add254c
5
5
  SHA512:
6
- metadata.gz: 9d888d4c46d3732d5d70dd805bd0eb82dd4c7891f0f43f6f2128d0cb2d652f99e7cf16792b1f464a58316490ec142a9ce2bda4717d6babe5b474726981c7bbbb
7
- data.tar.gz: '089a20e0ee40571836643325722bb716c32112b3d9dcc30f98a44b692cabc4ae2fb3b464030c2f9f0e61f989c82a583a7488077a5270139b4100270cc3f63357'
6
+ metadata.gz: 18d5cd892a84a28d04a49d011163b2aff7cf95c5a3024c8c61b8709e965f74b829d1f40d22364981de2fbe2b2846d4765f1cb58e649bab51af4ee97326e39801
7
+ data.tar.gz: 879ac81b3a5d090ba9d017509aca61e92c9d7b22aa6f7d1b90b9cf1826b261ccbe06d7662622ffb7ca0b5e5c4f7d318cb3682b47dc1d884216c52829b49a60e9
@@ -29,6 +29,10 @@ module Google
29
29
  ##
30
30
  # Client for the DataScanService service.
31
31
  #
32
+ # DataScanService manages DataScan resources which can be configured to run
33
+ # various types of data scanning workload and generate enriched metadata (e.g.
34
+ # Data Profile, Data Quality) for the data source.
35
+ #
32
36
  class Client
33
37
  include Paths
34
38
 
@@ -184,7 +188,7 @@ module Google
184
188
  # Service calls
185
189
 
186
190
  ##
187
- # Creates a dataScan resource.
191
+ # Creates a DataScan resource.
188
192
  #
189
193
  # @overload create_data_scan(request, options = nil)
190
194
  # Pass arguments to `create_data_scan` via a request object, either of type
@@ -203,13 +207,14 @@ module Google
203
207
  #
204
208
  # @param parent [::String]
205
209
  # Required. The resource name of the parent location:
206
- # projects/\\{project}/locations/\\{location_id}
207
- # where `{project}` refers to a project_id or project_number and
210
+ # `projects/{project}/locations/{location_id}`
211
+ # where `project` refers to a *project_id* or *project_number* and
208
212
  # `location_id` refers to a GCP region.
209
213
  # @param data_scan [::Google::Cloud::Dataplex::V1::DataScan, ::Hash]
210
214
  # Required. DataScan resource.
211
215
  # @param data_scan_id [::String]
212
216
  # Required. DataScan identifier.
217
+ #
213
218
  # * Must contain only lowercase letters, numbers and hyphens.
214
219
  # * Must start with a letter.
215
220
  # * Must end with a number or a letter.
@@ -289,7 +294,7 @@ module Google
289
294
  end
290
295
 
291
296
  ##
292
- # Update the dataScan resource.
297
+ # Updates a DataScan resource.
293
298
  #
294
299
  # @overload update_data_scan(request, options = nil)
295
300
  # Pass arguments to `update_data_scan` via a request object, either of type
@@ -307,7 +312,8 @@ module Google
307
312
  # the default parameter values, pass an empty Hash as a request object (see above).
308
313
  #
309
314
  # @param data_scan [::Google::Cloud::Dataplex::V1::DataScan, ::Hash]
310
- # Required. Update description.
315
+ # Required. DataScan resource to be updated.
316
+ #
311
317
  # Only fields specified in `update_mask` are updated.
312
318
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
313
319
  # Required. Mask of fields to update.
@@ -385,7 +391,7 @@ module Google
385
391
  end
386
392
 
387
393
  ##
388
- # Delete the dataScan resource.
394
+ # Deletes a DataScan resource.
389
395
  #
390
396
  # @overload delete_data_scan(request, options = nil)
391
397
  # Pass arguments to `delete_data_scan` via a request object, either of type
@@ -404,8 +410,8 @@ module Google
404
410
  #
405
411
  # @param name [::String]
406
412
  # Required. The resource name of the dataScan:
407
- # projects/\\{project}/locations/\\{location_id}/dataScans/\\{data_scan_id}
408
- # where `{project}` refers to a project_id or project_number and
413
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
414
+ # where `project` refers to a *project_id* or *project_number* and
409
415
  # `location_id` refers to a GCP region.
410
416
  #
411
417
  # @yield [response, operation] Access the result along with the RPC operation
@@ -481,7 +487,7 @@ module Google
481
487
  end
482
488
 
483
489
  ##
484
- # Get dataScan resource.
490
+ # Gets a DataScan resource.
485
491
  #
486
492
  # @overload get_data_scan(request, options = nil)
487
493
  # Pass arguments to `get_data_scan` via a request object, either of type
@@ -500,12 +506,11 @@ module Google
500
506
  #
501
507
  # @param name [::String]
502
508
  # Required. The resource name of the dataScan:
503
- # projects/\\{project}/locations/\\{location_id}/dataScans/\\{data_scan_id}
504
- # where `{project}` refers to a project_id or project_number and
509
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
510
+ # where `project` refers to a *project_id* or *project_number* and
505
511
  # `location_id` refers to a GCP region.
506
512
  # @param view [::Google::Cloud::Dataplex::V1::GetDataScanRequest::DataScanView]
507
- # Optional. Used to select the subset of DataScan information to return.
508
- # Defaults to `BASIC`.
513
+ # Optional. Select the DataScan view to return. Defaults to `BASIC`.
509
514
  #
510
515
  # @yield [response, operation] Access the result along with the RPC operation
511
516
  # @yieldparam response [::Google::Cloud::Dataplex::V1::DataScan]
@@ -572,7 +577,7 @@ module Google
572
577
  end
573
578
 
574
579
  ##
575
- # Lists dataScans.
580
+ # Lists DataScans.
576
581
  #
577
582
  # @overload list_data_scans(request, options = nil)
578
583
  # Pass arguments to `list_data_scans` via a request object, either of type
@@ -590,8 +595,9 @@ module Google
590
595
  # the default parameter values, pass an empty Hash as a request object (see above).
591
596
  #
592
597
  # @param parent [::String]
593
- # Required. projects/\\{project}/locations/\\{location_id}
594
- # where `{project}` refers to a project_id or project_number and
598
+ # Required. The resource name of the parent location:
599
+ # `projects/{project}/locations/{location_id}`
600
+ # where `project` refers to a *project_id* or *project_number* and
595
601
  # `location_id` refers to a GCP region.
596
602
  # @param page_size [::Integer]
597
603
  # Optional. Maximum number of dataScans to return. The service may return
@@ -605,7 +611,7 @@ module Google
605
611
  # @param filter [::String]
606
612
  # Optional. Filter request.
607
613
  # @param order_by [::String]
608
- # Optional. Order by fields (name or create_time) for the result.
614
+ # Optional. Order by fields (`name` or `create_time`) for the result.
609
615
  # If not specified, the ordering is undefined.
610
616
  #
611
617
  # @yield [response, operation] Access the result along with the RPC operation
@@ -680,7 +686,7 @@ module Google
680
686
  end
681
687
 
682
688
  ##
683
- # Run an on demand execution of a DataScan.
689
+ # Runs an on-demand execution of a DataScan
684
690
  #
685
691
  # @overload run_data_scan(request, options = nil)
686
692
  # Pass arguments to `run_data_scan` via a request object, either of type
@@ -699,10 +705,11 @@ module Google
699
705
  #
700
706
  # @param name [::String]
701
707
  # Required. The resource name of the DataScan:
702
- # projects/\\{project}/locations/\\{location_id}/dataScans/\\{data_scan_id}.
703
- # where `{project}` refers to a project_id or project_number and
708
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`.
709
+ # where `project` refers to a *project_id* or *project_number* and
704
710
  # `location_id` refers to a GCP region.
705
- # Only on-demand DataScans are allowed.
711
+ #
712
+ # Only **OnDemand** data scans are allowed.
706
713
  #
707
714
  # @yield [response, operation] Access the result along with the RPC operation
708
715
  # @yieldparam response [::Google::Cloud::Dataplex::V1::RunDataScanResponse]
@@ -769,7 +776,7 @@ module Google
769
776
  end
770
777
 
771
778
  ##
772
- # Get DataScanJob resource.
779
+ # Gets a DataScanJob resource.
773
780
  #
774
781
  # @overload get_data_scan_job(request, options = nil)
775
782
  # Pass arguments to `get_data_scan_job` via a request object, either of type
@@ -788,12 +795,11 @@ module Google
788
795
  #
789
796
  # @param name [::String]
790
797
  # Required. The resource name of the DataScanJob:
791
- # projects/\\{project}/locations/\\{location_id}/dataScans/\\{data_scan_id}/dataScanJobs/\\{data_scan_job_id}
792
- # where `{project}` refers to a project_id or project_number and
798
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`
799
+ # where `project` refers to a *project_id* or *project_number* and
793
800
  # `location_id` refers to a GCP region.
794
801
  # @param view [::Google::Cloud::Dataplex::V1::GetDataScanJobRequest::DataScanJobView]
795
- # Optional. Used to select the subset of DataScan information to return.
796
- # Defaults to `BASIC`.
802
+ # Optional. Select the DataScanJob view to return. Defaults to `BASIC`.
797
803
  #
798
804
  # @yield [response, operation] Access the result along with the RPC operation
799
805
  # @yieldparam response [::Google::Cloud::Dataplex::V1::DataScanJob]
@@ -860,7 +866,7 @@ module Google
860
866
  end
861
867
 
862
868
  ##
863
- # Lists DataScanJobs under the given dataScan.
869
+ # Lists DataScanJobs under the given DataScan.
864
870
  #
865
871
  # @overload list_data_scan_jobs(request, options = nil)
866
872
  # Pass arguments to `list_data_scan_jobs` via a request object, either of type
@@ -879,8 +885,8 @@ module Google
879
885
  #
880
886
  # @param parent [::String]
881
887
  # Required. The resource name of the parent environment:
882
- # projects/\\{project}/locations/\\{location_id}/dataScans/\\{data_scan_id}
883
- # where `{project}` refers to a project_id or project_number and
888
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
889
+ # where `project` refers to a *project_id* or *project_number* and
884
890
  # `location_id` refers to a GCP region.
885
891
  # @param page_size [::Integer]
886
892
  # Optional. Maximum number of DataScanJobs to return. The service may return
@@ -32,6 +32,10 @@ module Google
32
32
  module Dataplex
33
33
  module V1
34
34
  ##
35
+ # DataScanService manages DataScan resources which can be configured to run
36
+ # various types of data scanning workload and generate enriched metadata (e.g.
37
+ # Data Profile, Data Quality) for the data source.
38
+ #
35
39
  # @example Load this service and instantiate a gRPC client
36
40
  #
37
41
  # require "google/cloud/dataplex/v1/data_scan_service"
@@ -24,6 +24,9 @@ module Google
24
24
  module Dataplex
25
25
  module V1
26
26
  module DataScanService
27
+ # DataScanService manages DataScan resources which can be configured to run
28
+ # various types of data scanning workload and generate enriched metadata (e.g.
29
+ # Data Profile, Data Quality) for the data source.
27
30
  class Service
28
31
 
29
32
  include ::GRPC::GenericService
@@ -32,21 +35,21 @@ module Google
32
35
  self.unmarshal_class_method = :decode
33
36
  self.service_name = 'google.cloud.dataplex.v1.DataScanService'
34
37
 
35
- # Creates a dataScan resource.
38
+ # Creates a DataScan resource.
36
39
  rpc :CreateDataScan, ::Google::Cloud::Dataplex::V1::CreateDataScanRequest, ::Google::Longrunning::Operation
37
- # Update the dataScan resource.
40
+ # Updates a DataScan resource.
38
41
  rpc :UpdateDataScan, ::Google::Cloud::Dataplex::V1::UpdateDataScanRequest, ::Google::Longrunning::Operation
39
- # Delete the dataScan resource.
42
+ # Deletes a DataScan resource.
40
43
  rpc :DeleteDataScan, ::Google::Cloud::Dataplex::V1::DeleteDataScanRequest, ::Google::Longrunning::Operation
41
- # Get dataScan resource.
44
+ # Gets a DataScan resource.
42
45
  rpc :GetDataScan, ::Google::Cloud::Dataplex::V1::GetDataScanRequest, ::Google::Cloud::Dataplex::V1::DataScan
43
- # Lists dataScans.
46
+ # Lists DataScans.
44
47
  rpc :ListDataScans, ::Google::Cloud::Dataplex::V1::ListDataScansRequest, ::Google::Cloud::Dataplex::V1::ListDataScansResponse
45
- # Run an on demand execution of a DataScan.
48
+ # Runs an on-demand execution of a DataScan
46
49
  rpc :RunDataScan, ::Google::Cloud::Dataplex::V1::RunDataScanRequest, ::Google::Cloud::Dataplex::V1::RunDataScanResponse
47
- # Get DataScanJob resource.
50
+ # Gets a DataScanJob resource.
48
51
  rpc :GetDataScanJob, ::Google::Cloud::Dataplex::V1::GetDataScanJobRequest, ::Google::Cloud::Dataplex::V1::DataScanJob
49
- # Lists DataScanJobs under the given dataScan.
52
+ # Lists DataScanJobs under the given DataScan.
50
53
  rpc :ListDataScanJobs, ::Google::Cloud::Dataplex::V1::ListDataScanJobsRequest, ::Google::Cloud::Dataplex::V1::ListDataScanJobsResponse
51
54
  end
52
55
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dataplex
23
23
  module V1
24
- VERSION = "0.6.0"
24
+ VERSION = "0.6.1"
25
25
  end
26
26
  end
27
27
  end
@@ -25,8 +25,8 @@ module Google
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
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
28
+ # `projects/{project}/locations/{location_id}`
29
+ # where `project` refers to a *project_id* or *project_number* and
30
30
  # `location_id` refers to a GCP region.
31
31
  # @!attribute [rw] data_scan
32
32
  # @return [::Google::Cloud::Dataplex::V1::DataScan]
@@ -34,6 +34,7 @@ module Google
34
34
  # @!attribute [rw] data_scan_id
35
35
  # @return [::String]
36
36
  # Required. DataScan identifier.
37
+ #
37
38
  # * Must contain only lowercase letters, numbers and hyphens.
38
39
  # * Must start with a letter.
39
40
  # * Must end with a number or a letter.
@@ -47,7 +48,8 @@ module Google
47
48
  # Update dataScan request.
48
49
  # @!attribute [rw] data_scan
49
50
  # @return [::Google::Cloud::Dataplex::V1::DataScan]
50
- # Required. Update description.
51
+ # Required. DataScan resource to be updated.
52
+ #
51
53
  # Only fields specified in `update_mask` are updated.
52
54
  # @!attribute [rw] update_mask
53
55
  # @return [::Google::Protobuf::FieldMask]
@@ -61,8 +63,8 @@ module Google
61
63
  # @!attribute [rw] name
62
64
  # @return [::String]
63
65
  # 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
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
67
+ # where `project` refers to a *project_id* or *project_number* and
66
68
  # `location_id` refers to a GCP region.
67
69
  class DeleteDataScanRequest
68
70
  include ::Google::Protobuf::MessageExts
@@ -73,23 +75,22 @@ module Google
73
75
  # @!attribute [rw] name
74
76
  # @return [::String]
75
77
  # 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
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
79
+ # where `project` refers to a *project_id* or *project_number* and
78
80
  # `location_id` refers to a GCP region.
79
81
  # @!attribute [rw] view
80
82
  # @return [::Google::Cloud::Dataplex::V1::GetDataScanRequest::DataScanView]
81
- # Optional. Used to select the subset of DataScan information to return.
82
- # Defaults to `BASIC`.
83
+ # Optional. Select the DataScan view to return. Defaults to `BASIC`.
83
84
  class GetDataScanRequest
84
85
  include ::Google::Protobuf::MessageExts
85
86
  extend ::Google::Protobuf::MessageExts::ClassMethods
86
87
 
87
- # DataScan views for getting a partial dataScan.
88
+ # DataScan view options.
88
89
  module DataScanView
89
90
  # The API will default to the `BASIC` view.
90
91
  DATA_SCAN_VIEW_UNSPECIFIED = 0
91
92
 
92
- # Basic view that does not include spec and result.
93
+ # Basic view that does not include *spec* and *result*.
93
94
  BASIC = 1
94
95
 
95
96
  # Include everything.
@@ -100,8 +101,9 @@ module Google
100
101
  # List dataScans request.
101
102
  # @!attribute [rw] parent
102
103
  # @return [::String]
103
- # Required. projects/\\{project}/locations/\\{location_id}
104
- # where `{project}` refers to a project_id or project_number and
104
+ # Required. The resource name of the parent location:
105
+ # `projects/{project}/locations/{location_id}`
106
+ # where `project` refers to a *project_id* or *project_number* and
105
107
  # `location_id` refers to a GCP region.
106
108
  # @!attribute [rw] page_size
107
109
  # @return [::Integer]
@@ -119,7 +121,7 @@ module Google
119
121
  # Optional. Filter request.
120
122
  # @!attribute [rw] order_by
121
123
  # @return [::String]
122
- # Optional. Order by fields (name or create_time) for the result.
124
+ # Optional. Order by fields (`name` or `create_time`) for the result.
123
125
  # If not specified, the ordering is undefined.
124
126
  class ListDataScansRequest
125
127
  include ::Google::Protobuf::MessageExts
@@ -129,7 +131,7 @@ module Google
129
131
  # List dataScans response.
130
132
  # @!attribute [rw] data_scans
131
133
  # @return [::Array<::Google::Cloud::Dataplex::V1::DataScan>]
132
- # DataScans (metadata only) under the given parent location.
134
+ # DataScans (`BASIC` view only) under the given parent location.
133
135
  # @!attribute [rw] next_page_token
134
136
  # @return [::String]
135
137
  # Token to retrieve the next page of results, or empty if there are no more
@@ -146,10 +148,11 @@ module Google
146
148
  # @!attribute [rw] name
147
149
  # @return [::String]
148
150
  # 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
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`.
152
+ # where `project` refers to a *project_id* or *project_number* and
151
153
  # `location_id` refers to a GCP region.
152
- # Only on-demand DataScans are allowed.
154
+ #
155
+ # Only **OnDemand** data scans are allowed.
153
156
  class RunDataScanRequest
154
157
  include ::Google::Protobuf::MessageExts
155
158
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -158,7 +161,7 @@ module Google
158
161
  # Run DataScan Response.
159
162
  # @!attribute [rw] job
160
163
  # @return [::Google::Cloud::Dataplex::V1::DataScanJob]
161
- # DataScanJob created by RunDataScan API.
164
+ # DataScanJob created by RunDataScan request.
162
165
  class RunDataScanResponse
163
166
  include ::Google::Protobuf::MessageExts
164
167
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -168,23 +171,22 @@ module Google
168
171
  # @!attribute [rw] name
169
172
  # @return [::String]
170
173
  # 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
174
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`
175
+ # where `project` refers to a *project_id* or *project_number* and
173
176
  # `location_id` refers to a GCP region.
174
177
  # @!attribute [rw] view
175
178
  # @return [::Google::Cloud::Dataplex::V1::GetDataScanJobRequest::DataScanJobView]
176
- # Optional. Used to select the subset of DataScan information to return.
177
- # Defaults to `BASIC`.
179
+ # Optional. Select the DataScanJob view to return. Defaults to `BASIC`.
178
180
  class GetDataScanJobRequest
179
181
  include ::Google::Protobuf::MessageExts
180
182
  extend ::Google::Protobuf::MessageExts::ClassMethods
181
183
 
182
- # DataScanJob views for getting a partial dataScanJob.
184
+ # DataScanJob view options.
183
185
  module DataScanJobView
184
186
  # The API will default to the `BASIC` view.
185
187
  DATA_SCAN_JOB_VIEW_UNSPECIFIED = 0
186
188
 
187
- # Basic view that does not include spec and result.
189
+ # Basic view that does not include *spec* and *result*.
188
190
  BASIC = 1
189
191
 
190
192
  # Include everything.
@@ -196,8 +198,8 @@ module Google
196
198
  # @!attribute [rw] parent
197
199
  # @return [::String]
198
200
  # 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
+ # `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
202
+ # where `project` refers to a *project_id* or *project_number* and
201
203
  # `location_id` refers to a GCP region.
202
204
  # @!attribute [rw] page_size
203
205
  # @return [::Integer]
@@ -219,7 +221,7 @@ module Google
219
221
  # List DataScanJobs response.
220
222
  # @!attribute [rw] data_scan_jobs
221
223
  # @return [::Array<::Google::Cloud::Dataplex::V1::DataScanJob>]
222
- # DataScanJobs (metadata only) under a given dataScan.
224
+ # DataScanJobs (`BASIC` view only) under a given dataScan.
223
225
  # @!attribute [rw] next_page_token
224
226
  # @return [::String]
225
227
  # Token to retrieve the next page of results, or empty if there are no more
@@ -242,8 +244,8 @@ module Google
242
244
  # @!attribute [r] name
243
245
  # @return [::String]
244
246
  # 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
+ # `projects/{project}/locations/{location_id}/dataScans/{datascan_id}`,
248
+ # where `project` refers to a *project_id* or *project_number* and
247
249
  # `location_id` refers to a GCP region.
248
250
  # @!attribute [r] uid
249
251
  # @return [::String]
@@ -252,10 +254,12 @@ module Google
252
254
  # @!attribute [rw] description
253
255
  # @return [::String]
254
256
  # Optional. Description of the scan.
257
+ #
255
258
  # * Must be between 1-1024 characters.
256
259
  # @!attribute [rw] display_name
257
260
  # @return [::String]
258
261
  # Optional. User friendly display name.
262
+ #
259
263
  # * Must be between 1-256 characters.
260
264
  # @!attribute [rw] labels
261
265
  # @return [::Google::Protobuf::Map{::String => ::String}]
@@ -275,7 +279,8 @@ module Google
275
279
  # @!attribute [rw] execution_spec
276
280
  # @return [::Google::Cloud::Dataplex::V1::DataScan::ExecutionSpec]
277
281
  # Optional. DataScan execution settings.
278
- # If not specified, the fields under it will use their default values.
282
+ #
283
+ # If not specified, the fields in it will use their default values.
279
284
  # @!attribute [r] execution_status
280
285
  # @return [::Google::Cloud::Dataplex::V1::DataScan::ExecutionStatus]
281
286
  # Output only. Status of the data scan execution.
@@ -302,12 +307,15 @@ module Google
302
307
  # @!attribute [rw] trigger
303
308
  # @return [::Google::Cloud::Dataplex::V1::Trigger]
304
309
  # 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.
310
+ #
311
+ # If not specified, the default is `OnDemand`, which means the scan will
312
+ # not run until the user calls `RunDataScan` API.
307
313
  # @!attribute [rw] field
308
314
  # @return [::String]
309
- # Immutable. The unnested field (Date or Timestamp) that contains values
310
- # that monotonically increase over time.
315
+ # Immutable. The unnested field (of type *Date* or *Timestamp*) that
316
+ # contains values which monotonically increase over time.
317
+ #
318
+ # If not specified, a data scan will run for all data in the table.
311
319
  class ExecutionSpec
312
320
  include ::Google::Protobuf::MessageExts
313
321
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -335,12 +343,12 @@ module Google
335
343
  end
336
344
  end
337
345
 
338
- # A DataScanJob represents an instance of a data scan.
346
+ # A DataScanJob represents an instance of DataScan execution.
339
347
  # @!attribute [r] name
340
348
  # @return [::String]
341
349
  # 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
350
+ # `projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}`,
351
+ # where `project` refers to a *project_id* or *project_number* and
344
352
  # `location_id` refers to a GCP region.
345
353
  # @!attribute [r] uid
346
354
  # @return [::String]
@@ -403,13 +411,13 @@ module Google
403
411
 
404
412
  # The type of DataScan.
405
413
  module DataScanType
406
- # The DataScan Type is unspecified.
414
+ # The DataScan type is unspecified.
407
415
  DATA_SCAN_TYPE_UNSPECIFIED = 0
408
416
 
409
- # Data Quality Scan.
417
+ # Data Quality scan.
410
418
  DATA_QUALITY = 1
411
419
 
412
- # Data Profile Scan.
420
+ # Data Profile scan.
413
421
  DATA_PROFILE = 2
414
422
  end
415
423
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dataplex-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.6.0
4
+ version: 0.6.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-01-06 00:00:00.000000000 Z
11
+ date: 2023-02-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -50,7 +50,7 @@ dependencies:
50
50
  requirements:
51
51
  - - ">="
52
52
  - !ruby/object:Gem::Version
53
- version: '0.0'
53
+ version: '0.3'
54
54
  - - "<"
55
55
  - !ruby/object:Gem::Version
56
56
  version: 2.a
@@ -60,7 +60,7 @@ dependencies:
60
60
  requirements:
61
61
  - - ">="
62
62
  - !ruby/object:Gem::Version
63
- version: '0.0'
63
+ version: '0.3'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a
@@ -70,7 +70,7 @@ dependencies:
70
70
  requirements:
71
71
  - - ">="
72
72
  - !ruby/object:Gem::Version
73
- version: '0.0'
73
+ version: '0.3'
74
74
  - - "<"
75
75
  - !ruby/object:Gem::Version
76
76
  version: 2.a
@@ -80,7 +80,7 @@ dependencies:
80
80
  requirements:
81
81
  - - ">="
82
82
  - !ruby/object:Gem::Version
83
- version: '0.0'
83
+ version: '0.3'
84
84
  - - "<"
85
85
  - !ruby/object:Gem::Version
86
86
  version: 2.a
@@ -290,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
290
290
  - !ruby/object:Gem::Version
291
291
  version: '0'
292
292
  requirements: []
293
- rubygems_version: 3.3.14
293
+ rubygems_version: 3.4.2
294
294
  signing_key:
295
295
  specification_version: 4
296
296
  summary: API Client library for the Dataplex V1 API