Stay organized with collections
Save and categorize content based on your preferences.
Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob.
The server makes a best effort to cancel the job, but success is not
guaranteed. Clients can use JobService.GetCustomJob or other methods to
check whether the cancellation succeeded or whether the job completed
despite cancellation. On successful cancellation, the CustomJob is not
deleted; instead it becomes a job with a CustomJob.error value with a
google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and
CustomJob.state is set to CANCELLED.
Arguments
Parameters
name
string
Required. The name of the CustomJob to cancel. Format: projects/{project}/locations/{location}/customJobs/{custom_job}
region
string
Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.
Raised exceptions
Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
Response
If successful, the response will be empty.
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation.