Skip to content

Commit 7a985a7

Browse files
feat(dataplex): update the api
#### dataplex:v1 The following keys were added: - schemas.GoogleCloudDataplexV1EntrySource.properties.location (Total Keys: 2)
1 parent 743be66 commit 7a985a7

File tree

5 files changed

+35
-20
lines changed

5 files changed

+35
-20
lines changed

docs/dyn/dataplex_v1.projects.locations.dataScans.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ <h2>Instance Methods</h2>
9090
<p class="firstline">Deletes a DataScan resource.</p>
9191
<p class="toc_element">
9292
<code><a href="#generateDataQualityRules">generateDataQualityRules(name, body=None, x__xgafv=None)</a></code></p>
93-
<p class="firstline">Generates recommended DataQualityRule from a data profiling DataScan.</p>
93+
<p class="firstline">Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.</p>
9494
<p class="toc_element">
9595
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
9696
<p class="firstline">Gets a DataScan resource.</p>
@@ -461,14 +461,14 @@ <h3>Method Details</h3>
461461

462462
<div class="method">
463463
<code class="details" id="generateDataQualityRules">generateDataQualityRules(name, body=None, x__xgafv=None)</code>
464-
<pre>Generates recommended DataQualityRule from a data profiling DataScan.
464+
<pre>Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.
465465

466466
Args:
467-
name: string, Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job. (required)
467+
name: string, Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) (required)
468468
body: object, The request body.
469469
The object takes the form of:
470470

471-
{ # Generate recommended DataQualityRules request.
471+
{ # Request details for generating data quality rule recommendations.
472472
}
473473

474474
x__xgafv: string, V1 error format.
@@ -479,8 +479,8 @@ <h3>Method Details</h3>
479479
Returns:
480480
An object of the form:
481481

482-
{ # Generate recommended DataQualityRules response.
483-
&quot;rule&quot;: [ # Generated recommended {@link DataQualityRule}s.
482+
{ # Response details for data quality rule recommendations.
483+
&quot;rule&quot;: [ # The data quality rules that Dataplex generates based on the results of a data profiling scan.
484484
{ # A rule captures data quality intent about a data source.
485485
&quot;column&quot;: &quot;A String&quot;, # Optional. The unnested column which this rule is evaluated against.
486486
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the rule. The maximum length is 1,024 characters.

docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ <h2>Instance Methods</h2>
7979
<p class="firstline">Close httplib2 connections.</p>
8080
<p class="toc_element">
8181
<code><a href="#generateDataQualityRules">generateDataQualityRules(name, body=None, x__xgafv=None)</a></code></p>
82-
<p class="firstline">Generates recommended DataQualityRule from a data profiling DataScan.</p>
82+
<p class="firstline">Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.</p>
8383
<p class="toc_element">
8484
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
8585
<p class="firstline">Gets a DataScanJob resource.</p>
@@ -97,14 +97,14 @@ <h3>Method Details</h3>
9797

9898
<div class="method">
9999
<code class="details" id="generateDataQualityRules">generateDataQualityRules(name, body=None, x__xgafv=None)</code>
100-
<pre>Generates recommended DataQualityRule from a data profiling DataScan.
100+
<pre>Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.
101101

102102
Args:
103-
name: string, Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job. (required)
103+
name: string, Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) (required)
104104
body: object, The request body.
105105
The object takes the form of:
106106

107-
{ # Generate recommended DataQualityRules request.
107+
{ # Request details for generating data quality rule recommendations.
108108
}
109109

110110
x__xgafv: string, V1 error format.
@@ -115,8 +115,8 @@ <h3>Method Details</h3>
115115
Returns:
116116
An object of the form:
117117

118-
{ # Generate recommended DataQualityRules response.
119-
&quot;rule&quot;: [ # Generated recommended {@link DataQualityRule}s.
118+
{ # Response details for data quality rule recommendations.
119+
&quot;rule&quot;: [ # The data quality rules that Dataplex generates based on the results of a data profiling scan.
120120
{ # A rule captures data quality intent about a data source.
121121
&quot;column&quot;: &quot;A String&quot;, # Optional. The unnested column which this rule is evaluated against.
122122
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the rule. The maximum length is 1,024 characters.

docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ <h3>Method Details</h3>
140140
&quot;labels&quot;: { # User-defined labels. The maximum size of keys and values is 128 characters each.
141141
&quot;a_key&quot;: &quot;A String&quot;,
142142
},
143+
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
143144
&quot;platform&quot;: &quot;A String&quot;, # The platform containing the source system. The maximum size of the field is 64 characters.
144145
&quot;resource&quot;: &quot;A String&quot;, # The name of the resource in the source system. The maximum size of the field is 4000 characters.
145146
&quot;system&quot;: &quot;A String&quot;, # The name of the source system. The maximum size of the field is 64 characters.
@@ -191,6 +192,7 @@ <h3>Method Details</h3>
191192
&quot;labels&quot;: { # User-defined labels. The maximum size of keys and values is 128 characters each.
192193
&quot;a_key&quot;: &quot;A String&quot;,
193194
},
195+
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
194196
&quot;platform&quot;: &quot;A String&quot;, # The platform containing the source system. The maximum size of the field is 64 characters.
195197
&quot;resource&quot;: &quot;A String&quot;, # The name of the resource in the source system. The maximum size of the field is 4000 characters.
196198
&quot;system&quot;: &quot;A String&quot;, # The name of the source system. The maximum size of the field is 64 characters.
@@ -248,6 +250,7 @@ <h3>Method Details</h3>
248250
&quot;labels&quot;: { # User-defined labels. The maximum size of keys and values is 128 characters each.
249251
&quot;a_key&quot;: &quot;A String&quot;,
250252
},
253+
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
251254
&quot;platform&quot;: &quot;A String&quot;, # The platform containing the source system. The maximum size of the field is 64 characters.
252255
&quot;resource&quot;: &quot;A String&quot;, # The name of the resource in the source system. The maximum size of the field is 4000 characters.
253256
&quot;system&quot;: &quot;A String&quot;, # The name of the source system. The maximum size of the field is 64 characters.
@@ -314,6 +317,7 @@ <h3>Method Details</h3>
314317
&quot;labels&quot;: { # User-defined labels. The maximum size of keys and values is 128 characters each.
315318
&quot;a_key&quot;: &quot;A String&quot;,
316319
},
320+
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
317321
&quot;platform&quot;: &quot;A String&quot;, # The platform containing the source system. The maximum size of the field is 64 characters.
318322
&quot;resource&quot;: &quot;A String&quot;, # The name of the resource in the source system. The maximum size of the field is 4000 characters.
319323
&quot;system&quot;: &quot;A String&quot;, # The name of the source system. The maximum size of the field is 64 characters.
@@ -376,6 +380,7 @@ <h3>Method Details</h3>
376380
&quot;labels&quot;: { # User-defined labels. The maximum size of keys and values is 128 characters each.
377381
&quot;a_key&quot;: &quot;A String&quot;,
378382
},
383+
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
379384
&quot;platform&quot;: &quot;A String&quot;, # The platform containing the source system. The maximum size of the field is 64 characters.
380385
&quot;resource&quot;: &quot;A String&quot;, # The name of the resource in the source system. The maximum size of the field is 4000 characters.
381386
&quot;system&quot;: &quot;A String&quot;, # The name of the source system. The maximum size of the field is 64 characters.
@@ -445,6 +450,7 @@ <h3>Method Details</h3>
445450
&quot;labels&quot;: { # User-defined labels. The maximum size of keys and values is 128 characters each.
446451
&quot;a_key&quot;: &quot;A String&quot;,
447452
},
453+
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
448454
&quot;platform&quot;: &quot;A String&quot;, # The platform containing the source system. The maximum size of the field is 64 characters.
449455
&quot;resource&quot;: &quot;A String&quot;, # The name of the resource in the source system. The maximum size of the field is 4000 characters.
450456
&quot;system&quot;: &quot;A String&quot;, # The name of the source system. The maximum size of the field is 64 characters.
@@ -499,6 +505,7 @@ <h3>Method Details</h3>
499505
&quot;labels&quot;: { # User-defined labels. The maximum size of keys and values is 128 characters each.
500506
&quot;a_key&quot;: &quot;A String&quot;,
501507
},
508+
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
502509
&quot;platform&quot;: &quot;A String&quot;, # The platform containing the source system. The maximum size of the field is 64 characters.
503510
&quot;resource&quot;: &quot;A String&quot;, # The name of the resource in the source system. The maximum size of the field is 4000 characters.
504511
&quot;system&quot;: &quot;A String&quot;, # The name of the source system. The maximum size of the field is 64 characters.

docs/dyn/dataplex_v1.projects.locations.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,7 @@ <h3>Method Details</h3>
276276
&quot;labels&quot;: { # User-defined labels. The maximum size of keys and values is 128 characters each.
277277
&quot;a_key&quot;: &quot;A String&quot;,
278278
},
279+
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
279280
&quot;platform&quot;: &quot;A String&quot;, # The platform containing the source system. The maximum size of the field is 64 characters.
280281
&quot;resource&quot;: &quot;A String&quot;, # The name of the resource in the source system. The maximum size of the field is 4000 characters.
281282
&quot;system&quot;: &quot;A String&quot;, # The name of the source system. The maximum size of the field is 64 characters.
@@ -342,6 +343,7 @@ <h3>Method Details</h3>
342343
&quot;labels&quot;: { # User-defined labels. The maximum size of keys and values is 128 characters each.
343344
&quot;a_key&quot;: &quot;A String&quot;,
344345
},
346+
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
345347
&quot;platform&quot;: &quot;A String&quot;, # The platform containing the source system. The maximum size of the field is 64 characters.
346348
&quot;resource&quot;: &quot;A String&quot;, # The name of the resource in the source system. The maximum size of the field is 4000 characters.
347349
&quot;system&quot;: &quot;A String&quot;, # The name of the source system. The maximum size of the field is 64 characters.
@@ -385,6 +387,7 @@ <h3>Method Details</h3>
385387
&quot;labels&quot;: { # User-defined labels. The maximum size of keys and values is 128 characters each.
386388
&quot;a_key&quot;: &quot;A String&quot;,
387389
},
390+
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
388391
&quot;platform&quot;: &quot;A String&quot;, # The platform containing the source system. The maximum size of the field is 64 characters.
389392
&quot;resource&quot;: &quot;A String&quot;, # The name of the resource in the source system. The maximum size of the field is 4000 characters.
390393
&quot;system&quot;: &quot;A String&quot;, # The name of the source system. The maximum size of the field is 64 characters.

googleapiclient/discovery_cache/documents/dataplex.v1.json

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -892,7 +892,7 @@
892892
]
893893
},
894894
"generateDataQualityRules": {
895-
"description": "Generates recommended DataQualityRule from a data profiling DataScan.",
895+
"description": "Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.",
896896
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:generateDataQualityRules",
897897
"httpMethod": "POST",
898898
"id": "dataplex.projects.locations.dataScans.generateDataQualityRules",
@@ -901,7 +901,7 @@
901901
],
902902
"parameters": {
903903
"name": {
904-
"description": "Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.",
904+
"description": "Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)",
905905
"location": "path",
906906
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
907907
"required": true,
@@ -1164,7 +1164,7 @@
11641164
"jobs": {
11651165
"methods": {
11661166
"generateDataQualityRules": {
1167-
"description": "Generates recommended DataQualityRule from a data profiling DataScan.",
1167+
"description": "Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.",
11681168
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:generateDataQualityRules",
11691169
"httpMethod": "POST",
11701170
"id": "dataplex.projects.locations.dataScans.jobs.generateDataQualityRules",
@@ -1173,7 +1173,7 @@
11731173
],
11741174
"parameters": {
11751175
"name": {
1176-
"description": "Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.",
1176+
"description": "Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)",
11771177
"location": "path",
11781178
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$",
11791179
"required": true,
@@ -5271,7 +5271,7 @@
52715271
}
52725272
}
52735273
},
5274-
"revision": "20240523",
5274+
"revision": "20240529",
52755275
"rootUrl": "https://dataplex.googleapis.com/",
52765276
"schemas": {
52775277
"Empty": {
@@ -8302,6 +8302,11 @@
83028302
"description": "User-defined labels. The maximum size of keys and values is 128 characters each.",
83038303
"type": "object"
83048304
},
8305+
"location": {
8306+
"description": "Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.",
8307+
"readOnly": true,
8308+
"type": "string"
8309+
},
83058310
"platform": {
83068311
"description": "The platform containing the source system. The maximum size of the field is 64 characters.",
83078312
"type": "string"
@@ -8628,17 +8633,17 @@
86288633
"type": "object"
86298634
},
86308635
"GoogleCloudDataplexV1GenerateDataQualityRulesRequest": {
8631-
"description": "Generate recommended DataQualityRules request.",
8636+
"description": "Request details for generating data quality rule recommendations.",
86328637
"id": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest",
86338638
"properties": {},
86348639
"type": "object"
86358640
},
86368641
"GoogleCloudDataplexV1GenerateDataQualityRulesResponse": {
8637-
"description": "Generate recommended DataQualityRules response.",
8642+
"description": "Response details for data quality rule recommendations.",
86388643
"id": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse",
86398644
"properties": {
86408645
"rule": {
8641-
"description": "Generated recommended {@link DataQualityRule}s.",
8646+
"description": "The data quality rules that Dataplex generates based on the results of a data profiling scan.",
86428647
"items": {
86438648
"$ref": "GoogleCloudDataplexV1DataQualityRule"
86448649
},

0 commit comments

Comments
 (0)