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.lakes.resources.tasks.methods.run (Total Keys: 12)
- schemas.GoogleCloudDataplexV1AssetResourceSpec.properties.readAccessMode.type (Total Keys: 1)
- schemas.GoogleCloudDataplexV1Entity.properties.access (Total Keys: 2)
- schemas.GoogleCloudDataplexV1RunTaskRequest (Total Keys: 2)
- schemas.GoogleCloudDataplexV1RunTaskResponse (Total Keys: 3)
- schemas.GoogleCloudDataplexV1StorageAccess (Total Keys: 4)
  • Loading branch information
yoshi-automation committed Dec 20, 2022
1 parent 91b60af commit 04bafe3
Show file tree
Hide file tree
Showing 4 changed files with 145 additions and 1 deletion.
38 changes: 38 additions & 0 deletions docs/dyn/dataplex_v1.projects.locations.lakes.tasks.html
Expand Up @@ -103,6 +103,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the task resource.</p>
<p class="toc_element">
<code><a href="#run">run(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Run an on demand execution of a Task.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.</p>
Expand Down Expand Up @@ -794,6 +797,41 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="run">run(name, body=None, x__xgafv=None)</code>
<pre>Run an on demand execution of a Task.

Args:
name: string, Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}. (required)
body: object, The request body.
The object takes the form of:

{
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{
&quot;job&quot;: { # A job represents an instance of a task. # Jobs created by RunTask API.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the job 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 job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.
&quot;retryCount&quot;: 42, # Output only. The number of times the job has been retried (excluding the initial attempt).
&quot;service&quot;: &quot;A String&quot;, # Output only. The underlying service running a job.
&quot;serviceJob&quot;: &quot;A String&quot;, # Output only. The full resource name for the job run under a particular service.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. The time when the job was started.
&quot;state&quot;: &quot;A String&quot;, # Output only. Execution state for the job.
&quot;uid&quot;: &quot;A String&quot;, # Output only. System generated globally unique ID for the job.
},
}</pre>
</div>

<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Expand Down
Expand Up @@ -167,6 +167,7 @@ <h3>Method Details</h3>
&quot;name&quot;: &quot;A String&quot;, # Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.
&quot;resourceSpec&quot;: { # Identifies the cloud resource that is referenced by this asset. # Required. Specification of the resource that is referenced by this asset.
&quot;name&quot;: &quot;A String&quot;, # Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id}
&quot;readAccessMode&quot;: &quot;A String&quot;, # Optional. Determines how read permissions are handled for each asset and their associated tables. Only available to storage buckets assets.
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. Type of resource.
},
&quot;resourceStatus&quot;: { # Status of the resource referenced by an asset. # Output only. Status of the resource referenced by this asset.
Expand Down Expand Up @@ -307,6 +308,7 @@ <h3>Method Details</h3>
&quot;name&quot;: &quot;A String&quot;, # Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.
&quot;resourceSpec&quot;: { # Identifies the cloud resource that is referenced by this asset. # Required. Specification of the resource that is referenced by this asset.
&quot;name&quot;: &quot;A String&quot;, # Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id}
&quot;readAccessMode&quot;: &quot;A String&quot;, # Optional. Determines how read permissions are handled for each asset and their associated tables. Only available to storage buckets assets.
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. Type of resource.
},
&quot;resourceStatus&quot;: { # Status of the resource referenced by an asset. # Output only. Status of the resource referenced by this asset.
Expand Down Expand Up @@ -436,6 +438,7 @@ <h3>Method Details</h3>
&quot;name&quot;: &quot;A String&quot;, # Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.
&quot;resourceSpec&quot;: { # Identifies the cloud resource that is referenced by this asset. # Required. Specification of the resource that is referenced by this asset.
&quot;name&quot;: &quot;A String&quot;, # Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id}
&quot;readAccessMode&quot;: &quot;A String&quot;, # Optional. Determines how read permissions are handled for each asset and their associated tables. Only available to storage buckets assets.
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. Type of resource.
},
&quot;resourceStatus&quot;: { # Status of the resource referenced by an asset. # Output only. Status of the resource referenced by this asset.
Expand Down Expand Up @@ -523,6 +526,7 @@ <h3>Method Details</h3>
&quot;name&quot;: &quot;A String&quot;, # Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.
&quot;resourceSpec&quot;: { # Identifies the cloud resource that is referenced by this asset. # Required. Specification of the resource that is referenced by this asset.
&quot;name&quot;: &quot;A String&quot;, # Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id}
&quot;readAccessMode&quot;: &quot;A String&quot;, # Optional. Determines how read permissions are handled for each asset and their associated tables. Only available to storage buckets assets.
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. Type of resource.
},
&quot;resourceStatus&quot;: { # Status of the resource referenced by an asset. # Output only. Status of the resource referenced by this asset.
Expand Down
18 changes: 18 additions & 0 deletions docs/dyn/dataplex_v1.projects.locations.lakes.zones.entities.html
Expand Up @@ -116,6 +116,9 @@ <h3>Method Details</h3>
The object takes the form of:

{ # Represents tables and fileset metadata contained within a zone.
&quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
&quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
},
&quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
&quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
&quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
Expand Down Expand Up @@ -189,6 +192,9 @@ <h3>Method Details</h3>
An object of the form:

{ # Represents tables and fileset metadata contained within a zone.
&quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
&quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
},
&quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
&quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
&quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
Expand Down Expand Up @@ -293,6 +299,9 @@ <h3>Method Details</h3>
An object of the form:

{ # Represents tables and fileset metadata contained within a zone.
&quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
&quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
},
&quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
&quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
&quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
Expand Down Expand Up @@ -382,6 +391,9 @@ <h3>Method Details</h3>
{ # List metadata entities response.
&quot;entities&quot;: [ # Entities in the specified parent zone.
{ # Represents tables and fileset metadata contained within a zone.
&quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
&quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
},
&quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
&quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
&quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
Expand Down Expand Up @@ -473,6 +485,9 @@ <h3>Method Details</h3>
The object takes the form of:

{ # Represents tables and fileset metadata contained within a zone.
&quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
&quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
},
&quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
&quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
&quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
Expand Down Expand Up @@ -546,6 +561,9 @@ <h3>Method Details</h3>
An object of the form:

{ # Represents tables and fileset metadata contained within a zone.
&quot;access&quot;: { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable.
&quot;read&quot;: &quot;A String&quot;, # Output only. Describes the read access mechanism of the data. Not user settable.
},
&quot;asset&quot;: &quot;A String&quot;, # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
&quot;catalogEntry&quot;: &quot;A String&quot;, # Output only. The name of the associated Data Catalog entry.
&quot;compatibility&quot;: { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with.
Expand Down
86 changes: 85 additions & 1 deletion googleapiclient/discovery_cache/documents/dataplex.v1.json
Expand Up @@ -2190,6 +2190,34 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
"run": {
"description": "Run an on demand execution of a Task.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:run",
"httpMethod": "POST",
"id": "dataplex.projects.locations.lakes.tasks.run",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:run",
"request": {
"$ref": "GoogleCloudDataplexV1RunTaskRequest"
},
"response": {
"$ref": "GoogleCloudDataplexV1RunTaskResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lakes/{lakesId}/tasks/{tasksId}:setIamPolicy",
Expand Down Expand Up @@ -3418,7 +3446,7 @@
}
}
},
"revision": "20221130",
"revision": "20221212",
"rootUrl": "https://dataplex.googleapis.com/",
"schemas": {
"Empty": {
Expand Down Expand Up @@ -3881,6 +3909,20 @@
"description": "Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id}",
"type": "string"
},
"readAccessMode": {
"description": "Optional. Determines how read permissions are handled for each asset and their associated tables. Only available to storage buckets assets.",
"enum": [
"ACCESS_MODE_UNSPECIFIED",
"DIRECT",
"MANAGED"
],
"enumDescriptions": [
"Access mode unspecified.",
"Default. Data is accessed directly using storage APIs.",
"Data is accessed through a managed interface using BigQuery APIs."
],
"type": "string"
},
"type": {
"description": "Required. Immutable. Type of resource.",
"enum": [
Expand Down Expand Up @@ -5096,6 +5138,11 @@
"description": "Represents tables and fileset metadata contained within a zone.",
"id": "GoogleCloudDataplexV1Entity",
"properties": {
"access": {
"$ref": "GoogleCloudDataplexV1StorageAccess",
"description": "Output only. Identifies the access mechanism to the entity. Not user settable.",
"readOnly": true
},
"asset": {
"description": "Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.",
"type": "string"
Expand Down Expand Up @@ -6049,6 +6096,21 @@
},
"type": "object"
},
"GoogleCloudDataplexV1RunTaskRequest": {
"id": "GoogleCloudDataplexV1RunTaskRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1RunTaskResponse": {
"id": "GoogleCloudDataplexV1RunTaskResponse",
"properties": {
"job": {
"$ref": "GoogleCloudDataplexV1Job",
"description": "Jobs created by RunTask API."
}
},
"type": "object"
},
"GoogleCloudDataplexV1ScannedData": {
"description": "The data scanned during processing (e.g. in incremental DataScan)",
"id": "GoogleCloudDataplexV1ScannedData",
Expand Down Expand Up @@ -6384,6 +6446,28 @@
},
"type": "object"
},
"GoogleCloudDataplexV1StorageAccess": {
"description": "Describes the access mechanism of the data within its storage location.",
"id": "GoogleCloudDataplexV1StorageAccess",
"properties": {
"read": {
"description": "Output only. Describes the read access mechanism of the data. Not user settable.",
"enum": [
"ACCESS_MODE_UNSPECIFIED",
"DIRECT",
"MANAGED"
],
"enumDescriptions": [
"Access mode unspecified.",
"Default. Data is accessed directly using storage APIs.",
"Data is accessed through a managed interface using BigQuery APIs."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudDataplexV1StorageFormat": {
"description": "Describes the format of the data within its storage location.",
"id": "GoogleCloudDataplexV1StorageFormat",
Expand Down

0 comments on commit 04bafe3

Please sign in to comment.