Skip to content

Commit afef49a

Browse files
feat(dataplex): update the api
#### dataplex:v1 The following keys were added: - schemas.GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig.properties.project.type (Total Keys: 1) - schemas.GoogleCloudDataplexV1DataQualityColumnResult.properties.dimensions (Total Keys: 3) - schemas.GoogleCloudDataplexV1DataQualityColumnResult.properties.passed (Total Keys: 2) - schemas.GoogleCloudDataplexV1DataQualityResult.properties.catalogPublishingStatus (Total Keys: 2) - schemas.GoogleCloudDataplexV1DataQualitySpec.properties.catalogPublishingEnabled.type (Total Keys: 1) - schemas.GoogleCloudDataplexV1DataScanCatalogPublishingStatus (Total Keys: 4) - schemas.GoogleCloudDataplexV1DataScanEvent.properties.catalogPublishingStatus.$ref (Total Keys: 1)
1 parent cd83de6 commit afef49a

6 files changed

+343
-186
lines changed

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

Lines changed: 75 additions & 0 deletions
Large diffs are not rendered by default.

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@ <h3>Method Details</h3>
206206
&quot;bigqueryPublishingConfig&quot;: { # Describes BigQuery publishing configurations. # Optional. Configuration for metadata publishing.
207207
&quot;connection&quot;: &quot;A String&quot;, # Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id}
208208
&quot;location&quot;: &quot;A String&quot;, # Optional. The location of the BigQuery dataset to publish BigLake external or non-BigLake external tables to. 1. If the Cloud Storage bucket is located in a multi-region bucket, then BigQuery dataset can be in the same multi-region bucket or any single region that is included in the same multi-region bucket. The datascan can be created in any single region that is included in the same multi-region bucket 2. If the Cloud Storage bucket is located in a dual-region bucket, then BigQuery dataset can be located in regions that are included in the dual-region bucket, or in a multi-region that includes the dual-region. The datascan can be created in any single region that is included in the same dual-region bucket. 3. If the Cloud Storage bucket is located in a single region, then BigQuery dataset can be in the same single region or any multi-region bucket that includes the same single region. The datascan will be created in the same single region as the bucket. 4. If the BigQuery dataset is in single region, it must be in the same single region as the datascan.For supported values, refer to https://cloud.google.com/bigquery/docs/locations#supported_locations.
209+
&quot;project&quot;: &quot;A String&quot;, # Optional. The project of the BigQuery dataset to publish BigLake external or non-BigLake external tables to. If not specified, the project of the Cloud Storage bucket will be used. The format is &quot;projects/{project_id_or_number}&quot;.
209210
&quot;tableType&quot;: &quot;A String&quot;, # Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables.
210211
},
211212
&quot;storageConfig&quot;: { # Configurations related to Cloud Storage as the data source. # Cloud Storage related configurations.
@@ -307,9 +308,22 @@ <h3>Method Details</h3>
307308
&quot;samplingPercent&quot;: 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
308309
},
309310
&quot;dataQualityResult&quot;: { # The output of a DataQualityScan. # Output only. The result of a data quality scan.
311+
&quot;catalogPublishingStatus&quot;: { # The status of publishing the data scan result to Catalog. # Output only. The status of publishing the data scan to Catalog.
312+
&quot;state&quot;: &quot;A String&quot;, # Output only. Execution state for catalog publishing.
313+
},
310314
&quot;columns&quot;: [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the &#x27;column&#x27; field set to it.
311315
{ # DataQualityColumnResult provides a more detailed, per-column view of the results.
312316
&quot;column&quot;: &quot;A String&quot;, # Output only. The column specified in the DataQualityRule.
317+
&quot;dimensions&quot;: [ # Output only. The dimension-level results for this column.
318+
{ # DataQualityDimensionResult provides a more detailed, per-dimension view of the results.
319+
&quot;dimension&quot;: { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is.
320+
&quot;name&quot;: &quot;A String&quot;, # Optional. The dimension name a rule belongs to. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
321+
},
322+
&quot;passed&quot;: True or False, # Output only. Whether the dimension passed or failed.
323+
&quot;score&quot;: 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the &#x27;dimension&#x27; field is set.The score ranges between 0, 100 (up to two decimal points).
324+
},
325+
],
326+
&quot;passed&quot;: True or False, # Output only. Whether the column passed or failed.
313327
&quot;score&quot;: 3.14, # Output only. The column-level data quality score for this data scan job if and only if the &#x27;column&#x27; field is set.The score ranges between between 0, 100 (up to two decimal points).
314328
},
315329
],
@@ -394,6 +408,7 @@ <h3>Method Details</h3>
394408
&quot;score&quot;: 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points).
395409
},
396410
&quot;dataQualitySpec&quot;: { # DataQualityScan related setting. # Output only. Settings for a data quality scan.
411+
&quot;catalogPublishingEnabled&quot;: True or False, # Optional. If set, the latest DataScan job result will be published to Dataplex Catalog.
397412
&quot;postScanActions&quot;: { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion.
398413
&quot;bigqueryExport&quot;: { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table.
399414
&quot;resultsTable&quot;: &quot;A String&quot;, # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
@@ -513,6 +528,7 @@ <h3>Method Details</h3>
513528
&quot;bigqueryPublishingConfig&quot;: { # Describes BigQuery publishing configurations. # Optional. Configuration for metadata publishing.
514529
&quot;connection&quot;: &quot;A String&quot;, # Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id}
515530
&quot;location&quot;: &quot;A String&quot;, # Optional. The location of the BigQuery dataset to publish BigLake external or non-BigLake external tables to. 1. If the Cloud Storage bucket is located in a multi-region bucket, then BigQuery dataset can be in the same multi-region bucket or any single region that is included in the same multi-region bucket. The datascan can be created in any single region that is included in the same multi-region bucket 2. If the Cloud Storage bucket is located in a dual-region bucket, then BigQuery dataset can be located in regions that are included in the dual-region bucket, or in a multi-region that includes the dual-region. The datascan can be created in any single region that is included in the same dual-region bucket. 3. If the Cloud Storage bucket is located in a single region, then BigQuery dataset can be in the same single region or any multi-region bucket that includes the same single region. The datascan will be created in the same single region as the bucket. 4. If the BigQuery dataset is in single region, it must be in the same single region as the datascan.For supported values, refer to https://cloud.google.com/bigquery/docs/locations#supported_locations.
531+
&quot;project&quot;: &quot;A String&quot;, # Optional. The project of the BigQuery dataset to publish BigLake external or non-BigLake external tables to. If not specified, the project of the Cloud Storage bucket will be used. The format is &quot;projects/{project_id_or_number}&quot;.
516532
&quot;tableType&quot;: &quot;A String&quot;, # Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables.
517533
},
518534
&quot;storageConfig&quot;: { # Configurations related to Cloud Storage as the data source. # Cloud Storage related configurations.
@@ -614,9 +630,22 @@ <h3>Method Details</h3>
614630
&quot;samplingPercent&quot;: 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
615631
},
616632
&quot;dataQualityResult&quot;: { # The output of a DataQualityScan. # Output only. The result of a data quality scan.
633+
&quot;catalogPublishingStatus&quot;: { # The status of publishing the data scan result to Catalog. # Output only. The status of publishing the data scan to Catalog.
634+
&quot;state&quot;: &quot;A String&quot;, # Output only. Execution state for catalog publishing.
635+
},
617636
&quot;columns&quot;: [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the &#x27;column&#x27; field set to it.
618637
{ # DataQualityColumnResult provides a more detailed, per-column view of the results.
619638
&quot;column&quot;: &quot;A String&quot;, # Output only. The column specified in the DataQualityRule.
639+
&quot;dimensions&quot;: [ # Output only. The dimension-level results for this column.
640+
{ # DataQualityDimensionResult provides a more detailed, per-dimension view of the results.
641+
&quot;dimension&quot;: { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is.
642+
&quot;name&quot;: &quot;A String&quot;, # Optional. The dimension name a rule belongs to. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
643+
},
644+
&quot;passed&quot;: True or False, # Output only. Whether the dimension passed or failed.
645+
&quot;score&quot;: 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the &#x27;dimension&#x27; field is set.The score ranges between 0, 100 (up to two decimal points).
646+
},
647+
],
648+
&quot;passed&quot;: True or False, # Output only. Whether the column passed or failed.
620649
&quot;score&quot;: 3.14, # Output only. The column-level data quality score for this data scan job if and only if the &#x27;column&#x27; field is set.The score ranges between between 0, 100 (up to two decimal points).
621650
},
622651
],
@@ -701,6 +730,7 @@ <h3>Method Details</h3>
701730
&quot;score&quot;: 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points).
702731
},
703732
&quot;dataQualitySpec&quot;: { # DataQualityScan related setting. # Output only. Settings for a data quality scan.
733+
&quot;catalogPublishingEnabled&quot;: True or False, # Optional. If set, the latest DataScan job result will be published to Dataplex Catalog.
704734
&quot;postScanActions&quot;: { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion.
705735
&quot;bigqueryExport&quot;: { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table.
706736
&quot;resultsTable&quot;: &quot;A String&quot;, # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID

0 commit comments

Comments
 (0)