Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.batchPredictionJobs.cancel
Cancels a BatchPredictionJob.
Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.
[[["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: batchPredictionJobs.cancel\n\n**Full name**: projects.locations.batchPredictionJobs.cancel\n\nCancels a BatchPredictionJob.\n\nStarts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetBatchPredictionJob](/vertex-ai/docs/reference/rest/v1/projects.locations.batchPredictionJobs/get#google.cloud.aiplatform.v1.JobService.GetBatchPredictionJob) or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its [BatchPredictionJob.state](/vertex-ai/docs/reference/rest/v1/projects.locations.batchPredictionJobs#BatchPredictionJob.FIELDS.state) is set to `CANCELLED`. Any files already outputted by the job are not deleted. \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 BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batchPredictionJob}`\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."]]
