From af3534c3f205ccfd6ab7fb959addcae80a3f0942 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 12 Mar 2024 07:08:26 +0000 Subject: [PATCH] feat(dataplex): update the api #### dataplex:v1 The following keys were added: - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActions.properties.notificationReport.$ref (Total Keys: 1) - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger (Total Keys: 2) - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger (Total Keys: 2) - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport (Total Keys: 6) - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients (Total Keys: 4) - schemas.GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger (Total Keys: 4) --- ...aplex_v1.projects.locations.dataScans.html | 70 +++++++++++++++++++ ..._v1.projects.locations.dataScans.jobs.html | 28 ++++++++ .../documents/dataplex.v1.json | 67 +++++++++++++++++- 3 files changed, 164 insertions(+), 1 deletion(-) diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 906395b3a9..2d6d6e53b1 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -298,6 +298,20 @@

Method Details

"bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "notificationReport": { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers. + "jobEndTrigger": { # This trigger is triggered whenever a scan job run ends, regardless of the result. # Optional. If set, report will be sent when a scan job ends. + }, + "jobFailureTrigger": { # This trigger is triggered when the scan job itself fails, regardless of the result. # Optional. If set, report will be sent when a scan job fails. + }, + "recipients": { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report. + "emails": [ # Optional. The email recipients who will receive the DataQualityScan results report. + "A String", + ], + }, + "scoreThresholdTrigger": { # This trigger is triggered when the DQ score in the job result is less than a specified input score. # Optional. If set, report will be sent when score threshold is met. + "scoreThreshold": 3.14, # Optional. The score range is in 0,100. + }, + }, }, "rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. @@ -625,6 +639,20 @@

Method Details

"bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "notificationReport": { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers. + "jobEndTrigger": { # This trigger is triggered whenever a scan job run ends, regardless of the result. # Optional. If set, report will be sent when a scan job ends. + }, + "jobFailureTrigger": { # This trigger is triggered when the scan job itself fails, regardless of the result. # Optional. If set, report will be sent when a scan job fails. + }, + "recipients": { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report. + "emails": [ # Optional. The email recipients who will receive the DataQualityScan results report. + "A String", + ], + }, + "scoreThresholdTrigger": { # This trigger is triggered when the DQ score in the job result is less than a specified input score. # Optional. If set, report will be sent when score threshold is met. + "scoreThreshold": 3.14, # Optional. The score range is in 0,100. + }, + }, }, "rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. @@ -936,6 +964,20 @@

Method Details

"bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "notificationReport": { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers. + "jobEndTrigger": { # This trigger is triggered whenever a scan job run ends, regardless of the result. # Optional. If set, report will be sent when a scan job ends. + }, + "jobFailureTrigger": { # This trigger is triggered when the scan job itself fails, regardless of the result. # Optional. If set, report will be sent when a scan job fails. + }, + "recipients": { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report. + "emails": [ # Optional. The email recipients who will receive the DataQualityScan results report. + "A String", + ], + }, + "scoreThresholdTrigger": { # This trigger is triggered when the DQ score in the job result is less than a specified input score. # Optional. If set, report will be sent when score threshold is met. + "scoreThreshold": 3.14, # Optional. The score range is in 0,100. + }, + }, }, "rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. @@ -1208,6 +1250,20 @@

Method Details

"bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "notificationReport": { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers. + "jobEndTrigger": { # This trigger is triggered whenever a scan job run ends, regardless of the result. # Optional. If set, report will be sent when a scan job ends. + }, + "jobFailureTrigger": { # This trigger is triggered when the scan job itself fails, regardless of the result. # Optional. If set, report will be sent when a scan job fails. + }, + "recipients": { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report. + "emails": [ # Optional. The email recipients who will receive the DataQualityScan results report. + "A String", + ], + }, + "scoreThresholdTrigger": { # This trigger is triggered when the DQ score in the job result is less than a specified input score. # Optional. If set, report will be sent when score threshold is met. + "scoreThreshold": 3.14, # Optional. The score range is in 0,100. + }, + }, }, "rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. @@ -1497,6 +1553,20 @@

Method Details

"bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "notificationReport": { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers. + "jobEndTrigger": { # This trigger is triggered whenever a scan job run ends, regardless of the result. # Optional. If set, report will be sent when a scan job ends. + }, + "jobFailureTrigger": { # This trigger is triggered when the scan job itself fails, regardless of the result. # Optional. If set, report will be sent when a scan job fails. + }, + "recipients": { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report. + "emails": [ # Optional. The email recipients who will receive the DataQualityScan results report. + "A String", + ], + }, + "scoreThresholdTrigger": { # This trigger is triggered when the DQ score in the job result is less than a specified input score. # Optional. If set, report will be sent when score threshold is met. + "scoreThreshold": 3.14, # Optional. The score range is in 0,100. + }, + }, }, "rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index 9ecdbc2fc7..e709ef8380 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -277,6 +277,20 @@

Method Details

"bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "notificationReport": { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers. + "jobEndTrigger": { # This trigger is triggered whenever a scan job run ends, regardless of the result. # Optional. If set, report will be sent when a scan job ends. + }, + "jobFailureTrigger": { # This trigger is triggered when the scan job itself fails, regardless of the result. # Optional. If set, report will be sent when a scan job fails. + }, + "recipients": { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report. + "emails": [ # Optional. The email recipients who will receive the DataQualityScan results report. + "A String", + ], + }, + "scoreThresholdTrigger": { # This trigger is triggered when the DQ score in the job result is less than a specified input score. # Optional. If set, report will be sent when score threshold is met. + "scoreThreshold": 3.14, # Optional. The score range is in 0,100. + }, + }, }, "rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. @@ -517,6 +531,20 @@

Method Details

"bigqueryExport": { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table. "resultsTable": "A String", # Optional. The BigQuery table to export DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "notificationReport": { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers. + "jobEndTrigger": { # This trigger is triggered whenever a scan job run ends, regardless of the result. # Optional. If set, report will be sent when a scan job ends. + }, + "jobFailureTrigger": { # This trigger is triggered when the scan job itself fails, regardless of the result. # Optional. If set, report will be sent when a scan job fails. + }, + "recipients": { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report. + "emails": [ # Optional. The email recipients who will receive the DataQualityScan results report. + "A String", + ], + }, + "scoreThresholdTrigger": { # This trigger is triggered when the DQ score in the job result is less than a specified input score. # Optional. If set, report will be sent when score threshold is met. + "scoreThreshold": 3.14, # Optional. The score range is in 0,100. + }, + }, }, "rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 69363edcf2..8966b43d21 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -4360,7 +4360,7 @@ } } }, -"revision": "20240224", +"revision": "20240304", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -6027,6 +6027,10 @@ "bigqueryExport": { "$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport", "description": "Optional. If set, results will be exported to the provided BigQuery table." +}, +"notificationReport": { +"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport", +"description": "Optional. If set, results will be sent to the provided notification receipts upon triggers." } }, "type": "object" @@ -6042,6 +6046,67 @@ }, "type": "object" }, +"GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger": { +"description": "This trigger is triggered whenever a scan job run ends, regardless of the result.", +"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger", +"properties": {}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger": { +"description": "This trigger is triggered when the scan job itself fails, regardless of the result.", +"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger", +"properties": {}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport": { +"description": "The configuration of notification report post scan action.", +"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport", +"properties": { +"jobEndTrigger": { +"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger", +"description": "Optional. If set, report will be sent when a scan job ends." +}, +"jobFailureTrigger": { +"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger", +"description": "Optional. If set, report will be sent when a scan job fails." +}, +"recipients": { +"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients", +"description": "Required. The recipients who will receive the notification report." +}, +"scoreThresholdTrigger": { +"$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger", +"description": "Optional. If set, report will be sent when score threshold is met." +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients": { +"description": "The individuals or groups who are designated to receive notifications upon triggers.", +"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients", +"properties": { +"emails": { +"description": "Optional. The email recipients who will receive the DataQualityScan results report.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger": { +"description": "This trigger is triggered when the DQ score in the job result is less than a specified input score.", +"id": "GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger", +"properties": { +"scoreThreshold": { +"description": "Optional. The score range is in 0,100.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1DataScan": { "description": "Represents a user-visible job which provides the insights for the related data source.For example: Data Quality: generates queries based on the rules and runs against the data to get data quality check results. Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).", "id": "GoogleCloudDataplexV1DataScan",