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)
googleapis · Mar 12, 2024 · af3534c · af3534c
1 parent 1e3f5a9
commit af3534c
Show file tree

Hide file tree

Showing 3 changed files with 164 additions and 1 deletion.
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html
@@ -298,6 +298,20 @@ <h3>Method Details</h3>
       &quot;bigqueryExport&quot;: { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table.
         &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
       },
+      &quot;notificationReport&quot;: { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers.
+        &quot;jobEndTrigger&quot;: { # 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.
+        },
+        &quot;jobFailureTrigger&quot;: { # 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.
+        },
+        &quot;recipients&quot;: { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report.
+          &quot;emails&quot;: [ # Optional. The email recipients who will receive the DataQualityScan results report.
+            &quot;A String&quot;,
+          ],
+        },
+        &quot;scoreThresholdTrigger&quot;: { # 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.
+          &quot;scoreThreshold&quot;: 3.14, # Optional. The score range is in 0,100.
+        },
+      },
     },
     &quot;rowFilter&quot;: &quot;A String&quot;, # 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 &gt;= 0 AND col2 &lt; 10
     &quot;rules&quot;: [ # Required. The list of rules to evaluate against a data source. At least one rule is required.
@@ -625,6 +639,20 @@ <h3>Method Details</h3>
       &quot;bigqueryExport&quot;: { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table.
         &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
       },
+      &quot;notificationReport&quot;: { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers.
+        &quot;jobEndTrigger&quot;: { # 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.
+        },
+        &quot;jobFailureTrigger&quot;: { # 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.
+        },
+        &quot;recipients&quot;: { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report.
+          &quot;emails&quot;: [ # Optional. The email recipients who will receive the DataQualityScan results report.
+            &quot;A String&quot;,
+          ],
+        },
+        &quot;scoreThresholdTrigger&quot;: { # 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.
+          &quot;scoreThreshold&quot;: 3.14, # Optional. The score range is in 0,100.
+        },
+      },
     },
     &quot;rowFilter&quot;: &quot;A String&quot;, # 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 &gt;= 0 AND col2 &lt; 10
     &quot;rules&quot;: [ # Required. The list of rules to evaluate against a data source. At least one rule is required.
@@ -936,6 +964,20 @@ <h3>Method Details</h3>
           &quot;bigqueryExport&quot;: { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table.
             &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
           },
+          &quot;notificationReport&quot;: { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers.
+            &quot;jobEndTrigger&quot;: { # 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.
+            },
+            &quot;jobFailureTrigger&quot;: { # 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.
+            },
+            &quot;recipients&quot;: { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report.
+              &quot;emails&quot;: [ # Optional. The email recipients who will receive the DataQualityScan results report.
+                &quot;A String&quot;,
+              ],
+            },
+            &quot;scoreThresholdTrigger&quot;: { # 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.
+              &quot;scoreThreshold&quot;: 3.14, # Optional. The score range is in 0,100.
+            },
+          },
         },
         &quot;rowFilter&quot;: &quot;A String&quot;, # 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 &gt;= 0 AND col2 &lt; 10
         &quot;rules&quot;: [ # Required. The list of rules to evaluate against a data source. At least one rule is required.
@@ -1208,6 +1250,20 @@ <h3>Method Details</h3>
       &quot;bigqueryExport&quot;: { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table.
         &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
       },
+      &quot;notificationReport&quot;: { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers.
+        &quot;jobEndTrigger&quot;: { # 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.
+        },
+        &quot;jobFailureTrigger&quot;: { # 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.
+        },
+        &quot;recipients&quot;: { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report.
+          &quot;emails&quot;: [ # Optional. The email recipients who will receive the DataQualityScan results report.
+            &quot;A String&quot;,
+          ],
+        },
+        &quot;scoreThresholdTrigger&quot;: { # 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.
+          &quot;scoreThreshold&quot;: 3.14, # Optional. The score range is in 0,100.
+        },
+      },
     },
     &quot;rowFilter&quot;: &quot;A String&quot;, # 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 &gt;= 0 AND col2 &lt; 10
     &quot;rules&quot;: [ # Required. The list of rules to evaluate against a data source. At least one rule is required.
@@ -1497,6 +1553,20 @@ <h3>Method Details</h3>
         &quot;bigqueryExport&quot;: { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table.
           &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
         },
+        &quot;notificationReport&quot;: { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers.
+          &quot;jobEndTrigger&quot;: { # 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.
+          },
+          &quot;jobFailureTrigger&quot;: { # 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.
+          },
+          &quot;recipients&quot;: { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report.
+            &quot;emails&quot;: [ # Optional. The email recipients who will receive the DataQualityScan results report.
+              &quot;A String&quot;,
+            ],
+          },
+          &quot;scoreThresholdTrigger&quot;: { # 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.
+            &quot;scoreThreshold&quot;: 3.14, # Optional. The score range is in 0,100.
+          },
+        },
       },
       &quot;rowFilter&quot;: &quot;A String&quot;, # 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 &gt;= 0 AND col2 &lt; 10
       &quot;rules&quot;: [ # 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
@@ -277,6 +277,20 @@ <h3>Method Details</h3>
       &quot;bigqueryExport&quot;: { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table.
         &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
       },
+      &quot;notificationReport&quot;: { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers.
+        &quot;jobEndTrigger&quot;: { # 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.
+        },
+        &quot;jobFailureTrigger&quot;: { # 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.
+        },
+        &quot;recipients&quot;: { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report.
+          &quot;emails&quot;: [ # Optional. The email recipients who will receive the DataQualityScan results report.
+            &quot;A String&quot;,
+          ],
+        },
+        &quot;scoreThresholdTrigger&quot;: { # 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.
+          &quot;scoreThreshold&quot;: 3.14, # Optional. The score range is in 0,100.
+        },
+      },
     },
     &quot;rowFilter&quot;: &quot;A String&quot;, # 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 &gt;= 0 AND col2 &lt; 10
     &quot;rules&quot;: [ # Required. The list of rules to evaluate against a data source. At least one rule is required.
@@ -517,6 +531,20 @@ <h3>Method Details</h3>
           &quot;bigqueryExport&quot;: { # The configuration of BigQuery export post scan action. # Optional. If set, results will be exported to the provided BigQuery table.
             &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
           },
+          &quot;notificationReport&quot;: { # The configuration of notification report post scan action. # Optional. If set, results will be sent to the provided notification receipts upon triggers.
+            &quot;jobEndTrigger&quot;: { # 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.
+            },
+            &quot;jobFailureTrigger&quot;: { # 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.
+            },
+            &quot;recipients&quot;: { # The individuals or groups who are designated to receive notifications upon triggers. # Required. The recipients who will receive the notification report.
+              &quot;emails&quot;: [ # Optional. The email recipients who will receive the DataQualityScan results report.
+                &quot;A String&quot;,
+              ],
+            },
+            &quot;scoreThresholdTrigger&quot;: { # 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.
+              &quot;scoreThreshold&quot;: 3.14, # Optional. The score range is in 0,100.
+            },
+          },
         },
         &quot;rowFilter&quot;: &quot;A String&quot;, # 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 &gt;= 0 AND col2 &lt; 10
         &quot;rules&quot;: [ # 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
@@ -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",