Method: projects.locations.metadataJobs.cancel

Cancels a metadata job.

If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

HTTP request

POST https://dataplex.googleapis.com/v1/{name=projects/*/locations/*/metadataJobs/*}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the job, in the format projects/{project_id_or_number}/locations/{locationId}/metadataJobs/{metadataJobId}

Authorization requires the following IAM permission on the specified resource name:

  • dataplex.metadataJobs.cancel

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • dataplex.metadataJobs.cancel

For more information, see the IAM documentation.