Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to code.CANCELLED, and PipelineJob.state is set to CANCELLED.
Endpoint
posthttps://{endpoint}/v1/{name}:cancel
Where {service-endpoint} is one of the supported service endpoints.
Path parameters
namestring
Required. The name of the PipelineJob to cancel. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}
Request body
The request body must be empty.
Response body
If successful, the response body is an empty JSON object.