Method: customJobs.cancel

Full name: projects.locations.customJobs.cancel

Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to code.CANCELLED, and CustomJob.state is set to CANCELLED.

Endpoint

post https://{service-endpoint}/v1/{name}:cancel

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

name string

Required. The name of the CustomJob to cancel. Format: projects/{project}/locations/{location}/customJobs/{customJob}

Request body

The request body must be empty.

Response body

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