Stay organized with collectionsSave and categorize content based on your preferences.
Full name: projects.locations.pipelineJobs.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 usePipelineService.GetPipelineJobor 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 aPipelineJob.errorvalue with agoogle.rpc.Status.codeof 1, corresponding tocode.CANCELLED, andPipelineJob.stateis set toCANCELLED.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: pipelineJobs.cancel\n\n**Full name**: projects.locations.pipelineJobs.cancel\n\nCancels 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](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs/get#google.cloud.aiplatform.v1.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](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs#PipelineJob.FIELDS.error) value with a [google.rpc.Status.code](/vertex-ai/docs/reference/rest/Shared.Types/ListOperationsResponse#Status.FIELDS.code) of 1, corresponding to `code.CANCELLED`, and [PipelineJob.state](/vertex-ai/docs/reference/rest/v1/projects.locations.pipelineJobs#PipelineJob.FIELDS.state) is set to `CANCELLED`. \n\n### Endpoint\n\npost `https:``/``/{service-endpoint}``/v1``/{name}:cancel` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`name` `string` \nRequired. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`\n\n### Request body\n\nThe request body must be empty. \n\n### Response body\n\nIf successful, the response body is an empty JSON object."]]
