Stay organized with collectionsSave and categorize content based on your preferences.
Full name: projects.locations.nasJobs.cancel
Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can useJobService.GetNasJobor other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with aNasJob.errorvalue with agoogle.rpc.Status.codeof 1, corresponding tocode.CANCELLED, andNasJob.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: nasJobs.cancel\n\n**Full name**: projects.locations.nasJobs.cancel\n\nCancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use [JobService.GetNasJob](/vertex-ai/docs/reference/rest/v1/projects.locations.nasJobs/get#google.cloud.aiplatform.v1.JobService.GetNasJob) or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a [NasJob.error](/vertex-ai/docs/reference/rest/v1/projects.locations.nasJobs#NasJob.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 [NasJob.state](/vertex-ai/docs/reference/rest/v1/projects.locations.nasJobs#NasJob.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 NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nasJob}`\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."]]
