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 use 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
value with a google.rpc.Status.code
of 1, corresponding to code.CANCELLED
, and NasJob.state
is set to CANCELLED
.
Endpoint
posthttps://{endpoint}/v1/{name}:cancel
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
name
string
Required. The name of the NasJob to cancel. Format: projects/{project}/locations/{location}/nasJobs/{nasJob}
Request body
The request body must be empty.
Response body
If successful, the response body is empty.