From deb509a4ee35381c0d9ee663ef8a6ef62748449f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 17 Dec 2024 07:10:19 +0000 Subject: [PATCH] feat(dataplex): update the api #### dataplex:v1 The following keys were added: - resources.projects.resources.locations.resources.dataScans.methods.delete.parameters.force (Total Keys: 2) --- ...aplex_v1.projects.locations.dataScans.html | 35 ++++++++++--------- ..._v1.projects.locations.dataScans.jobs.html | 4 +-- ...rojects.locations.entryGroups.entries.html | 2 +- docs/dyn/dataplex_v1.projects.locations.html | 4 +-- .../documents/dataplex.v1.json | 27 ++++++++------ 5 files changed, 39 insertions(+), 33 deletions(-) diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 012dd24af2..432dba1221 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -86,7 +86,7 @@

Instance Methods

create(parent, body=None, dataScanId=None, validateOnly=None, x__xgafv=None)

Creates a DataScan resource.

- delete(name, x__xgafv=None)

+ delete(name, force=None, x__xgafv=None)

Deletes a DataScan resource.

generateDataQualityRules(name, body=None, x__xgafv=None)

@@ -413,13 +413,13 @@

Method Details

}, "executionStatus": { # Status of the data scan execution. # Output only. Status of the data scan execution. "latestJobCreateTime": "A String", # Optional. The time when the DataScanJob execution was created. - "latestJobEndTime": "A String", # The time when the latest DataScanJob ended. - "latestJobStartTime": "A String", # The time when the latest DataScanJob started. + "latestJobEndTime": "A String", # Optional. The time when the latest DataScanJob ended. + "latestJobStartTime": "A String", # Optional. The time when the latest DataScanJob started. }, "labels": { # Optional. User-defined labels for the scan. "a_key": "A String", }, - "name": "A String", # Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region. + "name": "A String", # Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region. "state": "A String", # Output only. Current state of the DataScan. "type": "A String", # Output only. The type of DataScan. "uid": "A String", # Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name. @@ -458,11 +458,12 @@

Method Details

- delete(name, x__xgafv=None) + delete(name, force=None, x__xgafv=None) 
Deletes a DataScan resource.
 
 Args:
   name: string, Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a GCP region. (required)
+  force: boolean, Optional. If set to true, any child resources of this data scan will also be deleted. (Otherwise, the request will only work if the data scan has no child resources.)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -863,13 +864,13 @@ 
Method Details

   },
   "executionStatus": { # Status of the data scan execution. # Output only. Status of the data scan execution.
     "latestJobCreateTime": "A String", # Optional. The time when the DataScanJob execution was created.
-    "latestJobEndTime": "A String", # The time when the latest DataScanJob ended.
-    "latestJobStartTime": "A String", # The time when the latest DataScanJob started.
+    "latestJobEndTime": "A String", # Optional. The time when the latest DataScanJob ended.
+    "latestJobStartTime": "A String", # Optional. The time when the latest DataScanJob started.
   },
   "labels": { # Optional. User-defined labels for the scan.
     "a_key": "A String",
   },
-  "name": "A String", # Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
+  "name": "A String", # Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
   "state": "A String", # Output only. Current state of the DataScan.
   "type": "A String", # Output only. The type of DataScan.
   "uid": "A String", # Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
@@ -1228,13 +1229,13 @@ 
Method Details

       },
       "executionStatus": { # Status of the data scan execution. # Output only. Status of the data scan execution.
         "latestJobCreateTime": "A String", # Optional. The time when the DataScanJob execution was created.
-        "latestJobEndTime": "A String", # The time when the latest DataScanJob ended.
-        "latestJobStartTime": "A String", # The time when the latest DataScanJob started.
+        "latestJobEndTime": "A String", # Optional. The time when the latest DataScanJob ended.
+        "latestJobStartTime": "A String", # Optional. The time when the latest DataScanJob started.
       },
       "labels": { # Optional. User-defined labels for the scan.
         "a_key": "A String",
       },
-      "name": "A String", # Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
+      "name": "A String", # Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
       "state": "A String", # Output only. Current state of the DataScan.
       "type": "A String", # Output only. The type of DataScan.
       "uid": "A String", # Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
@@ -1267,7 +1268,7 @@ 
Method Details

   
Updates a DataScan resource.
 
 Args:
-  name: string, Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region. (required)
+  name: string, Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -1554,20 +1555,20 @@ 
Method Details

   },
   "executionStatus": { # Status of the data scan execution. # Output only. Status of the data scan execution.
     "latestJobCreateTime": "A String", # Optional. The time when the DataScanJob execution was created.
-    "latestJobEndTime": "A String", # The time when the latest DataScanJob ended.
-    "latestJobStartTime": "A String", # The time when the latest DataScanJob started.
+    "latestJobEndTime": "A String", # Optional. The time when the latest DataScanJob ended.
+    "latestJobStartTime": "A String", # Optional. The time when the latest DataScanJob started.
   },
   "labels": { # Optional. User-defined labels for the scan.
     "a_key": "A String",
   },
-  "name": "A String", # Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
+  "name": "A String", # Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
   "state": "A String", # Output only. Current state of the DataScan.
   "type": "A String", # Output only. The type of DataScan.
   "uid": "A String", # Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
   "updateTime": "A String", # Output only. The time when the scan was last updated.
 }
 
-  updateMask: string, Required. Mask of fields to update.
+  updateMask: string, Optional. Mask of fields to update.
   validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1886,7 +1887,7 @@ 
Method Details

     },
     "endTime": "A String", # Output only. The time when the DataScanJob ended.
     "message": "A String", # Output only. Additional information about the current state.
-    "name": "A String", # Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
+    "name": "A String", # Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
     "startTime": "A String", # Output only. The time when the DataScanJob was started.
     "state": "A String", # Output only. Execution state for the DataScanJob.
     "type": "A String", # Output only. The type of the parent DataScan.
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
index ed63c4fd6e..1dda71face 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
@@ -450,7 +450,7 @@ 
Method Details

   },
   "endTime": "A String", # Output only. The time when the DataScanJob ended.
   "message": "A String", # Output only. Additional information about the current state.
-  "name": "A String", # Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
+  "name": "A String", # Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
   "startTime": "A String", # Output only. The time when the DataScanJob was started.
   "state": "A String", # Output only. Execution state for the DataScanJob.
   "type": "A String", # Output only. The type of the parent DataScan.
@@ -744,7 +744,7 @@ 
Method Details

       },
       "endTime": "A String", # Output only. The time when the DataScanJob ended.
       "message": "A String", # Output only. Additional information about the current state.
-      "name": "A String", # Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
+      "name": "A String", # Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
       "startTime": "A String", # Output only. The time when the DataScanJob was started.
       "state": "A String", # Output only. Execution state for the DataScanJob.
       "type": "A String", # Output only. The type of the parent DataScan.
diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html
index 8754387caf..5555237f7e 100644
--- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html
+++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html
@@ -470,7 +470,7 @@ 
Method Details

 }
 
   allowMissing: boolean, Optional. If set to true and the entry doesn't exist, the service will create it.
-  aspectKeys: string, Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. * - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. (repeated)
+  aspectKeys: string, Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. (repeated)
   deleteMissingAspects: boolean, Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
   updateMask: string, Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html
index 7ed6b9d14b..c85012afbb 100644
--- a/docs/dyn/dataplex_v1.projects.locations.html
+++ b/docs/dyn/dataplex_v1.projects.locations.html
@@ -312,10 +312,10 @@ 
Method Details

 
 Args:
   name: string, Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. (required)
-  orderBy: string, Optional. Specifies the ordering of results.
+  orderBy: string, Optional. Specifies the ordering of results. Supported values are: * relevance (default) * last_modified_timestamp * last_modified_timestamp asc
   pageSize: integer, Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.
   pageToken: string, Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page.
-  query: string, Required. The query against which entries in scope should be matched.
+  query: string, Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog (https://cloud.google.com/dataplex/docs/search-syntax).
   scope: string, Optional. The scope under which the search should be operating. It must either be organizations/ or projects/. If it is unspecified, it defaults to the organization where the project provided in name is located.
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json
index f2ba8024a0..6925cc4ef6 100644
--- a/googleapiclient/discovery_cache/documents/dataplex.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json
@@ -712,7 +712,7 @@
 "type": "string"
 },
 "orderBy": {
-"description": "Optional. Specifies the ordering of results.",
+"description": "Optional. Specifies the ordering of results. Supported values are: * relevance (default) * last_modified_timestamp * last_modified_timestamp asc",
 "location": "query",
 "type": "string"
 },
@@ -728,7 +728,7 @@
 "type": "string"
 },
 "query": {
-"description": "Required. The query against which entries in scope should be matched.",
+"description": "Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog (https://cloud.google.com/dataplex/docs/search-syntax).",
 "location": "query",
 "type": "string"
 },
@@ -1335,6 +1335,11 @@
 "name"
 ],
 "parameters": {
+"force": {
+"description": "Optional. If set to true, any child resources of this data scan will also be deleted. (Otherwise, the request will only work if the data scan has no child resources.)",
+"location": "query",
+"type": "boolean"
+},
 "name": {
 "description": "Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a GCP region.",
 "location": "path",
@@ -1506,14 +1511,14 @@
 ],
 "parameters": {
 "name": {
-"description": "Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.",
+"description": "Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. Mask of fields to update.",
+"description": "Optional. Mask of fields to update.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -2717,7 +2722,7 @@
 "type": "boolean"
 },
 "aspectKeys": {
-"description": "Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. * - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.",
+"description": "Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -6239,7 +6244,7 @@
 }
 }
 },
-"revision": "20241106",
+"revision": "20241206",
 "rootUrl": "https://dataplex.googleapis.com/",
 "schemas": {
 "Empty": {
@@ -8494,7 +8499,7 @@
 "type": "object"
 },
 "name": {
-"description": "Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.",
+"description": "Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.",
 "readOnly": true,
 "type": "string"
 },
@@ -8825,12 +8830,12 @@
 "type": "string"
 },
 "latestJobEndTime": {
-"description": "The time when the latest DataScanJob ended.",
+"description": "Optional. The time when the latest DataScanJob ended.",
 "format": "google-datetime",
 "type": "string"
 },
 "latestJobStartTime": {
-"description": "The time when the latest DataScanJob started.",
+"description": "Optional. The time when the latest DataScanJob started.",
 "format": "google-datetime",
 "type": "string"
 }
@@ -8889,7 +8894,7 @@
 "type": "string"
 },
 "name": {
-"description": "Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.",
+"description": "Output only. Identifier. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.",
 "readOnly": true,
 "type": "string"
 },
@@ -9941,7 +9946,7 @@
 "id": "GoogleCloudDataplexV1ImportItem",
 "properties": {
 "aspectKeys": {
-"description": "The aspects to modify. Supports the following syntaxes: {aspect_type_reference}: matches aspects that belong to the specified aspect type and are attached directly to the entry. {aspect_type_reference}@{path}: matches aspects that belong to the specified aspect type and path. {aspect_type_reference}@*: matches aspects that belong to the specified aspect type for all paths.Replace {aspect_type_reference} with a reference to the aspect type, in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry.In FULL entry sync mode, Dataplex implicitly adds the keys for all of the required aspects of an entry.",
+"description": "The aspects to modify. Supports the following syntaxes: {aspect_type_reference}: matches aspects that belong to the specified aspect type and are attached directly to the entry. {aspect_type_reference}@{path}: matches aspects that belong to the specified aspect type and path. @* : matches aspects of the given type for all paths. *@path : matches aspects of all types on the given path. Replace {aspect_type_reference} with a reference to the aspect type, in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry.In FULL entry sync mode, Dataplex implicitly adds the keys for all of the required aspects of an entry.",
 "items": {
 "type": "string"
 },