POST /v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel
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.
Request
- Base URLhttps://aiplatform.googleapis.com
- AuthOAuth 2 and OAuth 2Implicit: https://accounts.google.com/o/oauth2/authScopes: https://www.googleapis.com/auth/cloud-platformAuthorization code: https://accounts.google.com/o/oauth2/authToken URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
Path parameters
Request body
Request message for PipelineService.CancelPipelineJob.
Response
Successful response
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Changes
No recorded changes to this operation across all 8 revisions of this API.