Method: googleapis.bigquery.v2.jobs.cancel

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. # IAM Permissions Requires the bigquery.jobs.update permission on the job resource. If the user matches the creator of the job, the bigquery.jobs.create permission on the project is required instead.

Arguments

Parameters
jobId	string Required. Job ID of the job to cancel
projectId	string Required. Project ID of the job to cancel
location	string The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the us or the eu multi-regional location * If the job's location is in a single region (for example, us-central1)

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 contains an instance of JobCancelResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- cancel:
    call: googleapis.bigquery.v2.jobs.cancel
    args:
        jobId: ...
        projectId: ...
        location: ...
    result: cancelResult

JSON

[
  {
    "cancel": {
      "call": "googleapis.bigquery.v2.jobs.cancel",
      "args": {
        "jobId": "...",
        "projectId": "...",
        "location": "..."
      },
      "result": "cancelResult"
    }
  }
]