Skip to content

Commit

Permalink
feat(dataplex): update the api
Browse files Browse the repository at this point in the history
#### dataplex:v1

The following keys were added:
- resources.projects.resources.locations.resources.dataScans.methods.delete.parameters.force (Total Keys: 2)
  • Loading branch information
yoshi-automation committed Dec 17, 2024
1 parent 283d79d commit deb509a
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 33 deletions.
35 changes: 18 additions & 17 deletions docs/dyn/dataplex_v1.projects.locations.dataScans.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h2>Instance Methods</h2>
<code><a href="#create">create(parent, body=None, dataScanId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a DataScan resource.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a DataScan resource.</p>
<p class="toc_element">
<code><a href="#generateDataQualityRules">generateDataQualityRules(name, body=None, x__xgafv=None)</a></code></p>
Expand Down Expand Up @@ -413,13 +413,13 @@ <h3>Method Details</h3>
},
&quot;executionStatus&quot;: { # Status of the data scan execution. # Output only. Status of the data scan execution.
&quot;latestJobCreateTime&quot;: &quot;A String&quot;, # Optional. The time when the DataScanJob execution was created.
&quot;latestJobEndTime&quot;: &quot;A String&quot;, # The time when the latest DataScanJob ended.
&quot;latestJobStartTime&quot;: &quot;A String&quot;, # The time when the latest DataScanJob started.
&quot;latestJobEndTime&quot;: &quot;A String&quot;, # Optional. The time when the latest DataScanJob ended.
&quot;latestJobStartTime&quot;: &quot;A String&quot;, # Optional. The time when the latest DataScanJob started.
},
&quot;labels&quot;: { # Optional. User-defined labels for the scan.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the DataScan.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of DataScan.
&quot;uid&quot;: &quot;A String&quot;, # 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.
Expand Down Expand Up @@ -458,11 +458,12 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
<pre>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
Expand Down Expand Up @@ -863,13 +864,13 @@ <h3>Method Details</h3>
},
&quot;executionStatus&quot;: { # Status of the data scan execution. # Output only. Status of the data scan execution.
&quot;latestJobCreateTime&quot;: &quot;A String&quot;, # Optional. The time when the DataScanJob execution was created.
&quot;latestJobEndTime&quot;: &quot;A String&quot;, # The time when the latest DataScanJob ended.
&quot;latestJobStartTime&quot;: &quot;A String&quot;, # The time when the latest DataScanJob started.
&quot;latestJobEndTime&quot;: &quot;A String&quot;, # Optional. The time when the latest DataScanJob ended.
&quot;latestJobStartTime&quot;: &quot;A String&quot;, # Optional. The time when the latest DataScanJob started.
},
&quot;labels&quot;: { # Optional. User-defined labels for the scan.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the DataScan.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of DataScan.
&quot;uid&quot;: &quot;A String&quot;, # 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.
Expand Down Expand Up @@ -1228,13 +1229,13 @@ <h3>Method Details</h3>
},
&quot;executionStatus&quot;: { # Status of the data scan execution. # Output only. Status of the data scan execution.
&quot;latestJobCreateTime&quot;: &quot;A String&quot;, # Optional. The time when the DataScanJob execution was created.
&quot;latestJobEndTime&quot;: &quot;A String&quot;, # The time when the latest DataScanJob ended.
&quot;latestJobStartTime&quot;: &quot;A String&quot;, # The time when the latest DataScanJob started.
&quot;latestJobEndTime&quot;: &quot;A String&quot;, # Optional. The time when the latest DataScanJob ended.
&quot;latestJobStartTime&quot;: &quot;A String&quot;, # Optional. The time when the latest DataScanJob started.
},
&quot;labels&quot;: { # Optional. User-defined labels for the scan.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the DataScan.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of DataScan.
&quot;uid&quot;: &quot;A String&quot;, # 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.
Expand Down Expand Up @@ -1267,7 +1268,7 @@ <h3>Method Details</h3>
<pre>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:

Expand Down Expand Up @@ -1554,20 +1555,20 @@ <h3>Method Details</h3>
},
&quot;executionStatus&quot;: { # Status of the data scan execution. # Output only. Status of the data scan execution.
&quot;latestJobCreateTime&quot;: &quot;A String&quot;, # Optional. The time when the DataScanJob execution was created.
&quot;latestJobEndTime&quot;: &quot;A String&quot;, # The time when the latest DataScanJob ended.
&quot;latestJobStartTime&quot;: &quot;A String&quot;, # The time when the latest DataScanJob started.
&quot;latestJobEndTime&quot;: &quot;A String&quot;, # Optional. The time when the latest DataScanJob ended.
&quot;latestJobStartTime&quot;: &quot;A String&quot;, # Optional. The time when the latest DataScanJob started.
},
&quot;labels&quot;: { # Optional. User-defined labels for the scan.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the DataScan.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of DataScan.
&quot;uid&quot;: &quot;A String&quot;, # 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.
&quot;updateTime&quot;: &quot;A String&quot;, # 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
Expand Down Expand Up @@ -1886,7 +1887,7 @@ <h3>Method Details</h3>
},
&quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the DataScanJob ended.
&quot;message&quot;: &quot;A String&quot;, # Output only. Additional information about the current state.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The time when the DataScanJob was started.
&quot;state&quot;: &quot;A String&quot;, # Output only. Execution state for the DataScanJob.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the parent DataScan.
Expand Down
4 changes: 2 additions & 2 deletions docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ <h3>Method Details</h3>
},
&quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the DataScanJob ended.
&quot;message&quot;: &quot;A String&quot;, # Output only. Additional information about the current state.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The time when the DataScanJob was started.
&quot;state&quot;: &quot;A String&quot;, # Output only. Execution state for the DataScanJob.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the parent DataScan.
Expand Down Expand Up @@ -744,7 +744,7 @@ <h3>Method Details</h3>
},
&quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the DataScanJob ended.
&quot;message&quot;: &quot;A String&quot;, # Output only. Additional information about the current state.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The time when the DataScanJob was started.
&quot;state&quot;: &quot;A String&quot;, # Output only. Execution state for the DataScanJob.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the parent DataScan.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ <h3>Method Details</h3>
}

allowMissing: boolean, Optional. If set to true and the entry doesn&#x27;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&#x27;t provided in the request.
updateMask: string, Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value &quot;aspects&quot;.If the update_mask is empty, the service will update all modifiable fields present in the request.
x__xgafv: string, V1 error format.
Expand Down
4 changes: 2 additions & 2 deletions docs/dyn/dataplex_v1.projects.locations.html
Original file line number Diff line number Diff line change
Expand Up @@ -312,10 +312,10 @@ <h3>Method Details</h3>

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 &lt;=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size &gt; 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
Expand Down
Loading

0 comments on commit deb509a

Please sign in to comment.