Bigquery.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.

POST/projects/{projectId}/jobs/{jobId}/cancel

Use it in a workflow

Add a step and choose the BigQuery connector.
Pick the Bigquery.jobs.cancel action (under jobs).
Fill in the fields below, then reference the result from later steps as {{bigqueryJobsCancel.response.data}}.

Request

Path parameters

projectIdstringrequired

[Required] Project ID of the job to cancel

jobIdstringrequired

[Required] Job ID of the job to cancel

Query parameters

altstring

Data format for the response.

One ofjson

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIpstring

Deprecated. Please use quotaUser instead.

locationstring

The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

Response

Returns 200 with an object. Read it in later steps with {{bigqueryJobsCancel.response.data.<field>}}.

jobobject

configurationobject8 fields

etagstring

[Output-only] A hash of this resource.

idstring

[Output-only] Opaque ID field of the job

jobReferenceobject3 fields

kindstring

[Output-only] The type of the resource.

Default "bigquery#job"

selfLinkstring

[Output-only] A URL that can be used to access this resource again.

statisticsobject20 fields

statusobject3 fields

user_emailstring

[Output-only] Email address of the user who ran the job.

kindstring

The resource type of the response.

Default "bigquery#jobCancelResponse"

json

{
  "job": {
    "configuration": {
      "copy": {
        "createDisposition": "string",
        "destinationEncryptionConfiguration": {
          "kmsKeyName": "string"
        },
        "destinationExpirationTime": null,
        "destinationTable": {
          "datasetId": "string",
          "projectId": "string",
          "tableId": "string"
        },
        "operationType": "string",
        "sourceTable": {
          "datasetId": "string",
          "projectId": "string",
          "tableId": "string"
        },
        "sourceTables": [
          {
            "datasetId": "string",
            "projectId": "string",
            "tableId": "string"
          }
        ],
        "writeDisposition": "string"
      },
      "dryRun": false,
      "extract": {
        "compression": "string",
        "destinationFormat": "string",
        "destinationUri": "string",
        "destinationUris": [
          "string"
        ],
        "fieldDelimiter": "string",
        "printHeader": true,
        "sourceModel": {
          "datasetId": "string",
          "modelId": "string",
          "projectId": "string"
        },
        "sourceTable": {
          "datasetId": "string",
          "projectId": "string",
          "tableId": "string"
        },
        "useAvroLogicalTypes": false
      },
      "jobTimeoutMs": "string",
      "jobType": "string",
      "labels": {},
      "load": {
        "allowJaggedRows": false,
        "allowQuotedNewlines": false,
        "autodetect": false,
        "clustering": {
          "fields": [
            "string"
          ]
        },
        "connectionProperties": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "createDisposition": "string",
        "createSession": false,
        "decimalTargetTypes": [
          "string"
        ],
        "destinationEncryptionConfiguration": {
          "kmsKeyName": "string"
        },
        "destinationTable": {
          "datasetId": "string",
          "projectId": "string",
          "tableId": "string"
        },
        "destinationTableProperties": {
          "description": "string",
          "expirationTime": "2025-01-01T00:00:00Z",
          "friendlyName": "string",
          "labels": {}
        },
        "encoding": "string"
      },
      "query": {
        "allowLargeResults": false,
        "clustering": {
          "fields": [
            "string"
          ]
        },
        "connectionProperties": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "continuous": false,
        "createDisposition": "string",
        "createSession": false,
        "defaultDataset": {
          "datasetId": "string",
          "projectId": "string"
        },
        "destinationEncryptionConfiguration": {
          "kmsKeyName": "string"
        },
        "destinationTable": {
          "datasetId": "string",
          "projectId": "string",
          "tableId": "string"
        },
        "flattenResults": true,
        "maximumBillingTier": 1,
        "maximumBytesBilled": "string"
      }
    },
    "etag": "string",
    "id": "string",
    "jobReference": {
      "jobId": "string",
      "location": "string",
      "projectId": "string"
    },
    "kind": "bigquery#job",
    "selfLink": "string",
    "statistics": {
      "completionRatio": 0,
      "copy": {
        "copied_logical_bytes": "string",
        "copied_rows": "string"
      },
      "creationTime": "string",
      "dataMaskingStatistics": {
        "dataMaskingApplied": false
      },
      "endTime": "string",
      "extract": {
        "destinationUriFileCounts": [
          "string"
        ],
        "inputBytes": "string"
      },
      "load": {
        "badRecords": "string",
        "inputFileBytes": "string",
        "inputFiles": "string",
        "outputBytes": "string",
        "outputRows": "string"
      },
      "numChildJobs": "string",
      "parentJobId": "string",
      "query": {
        "biEngineStatistics": {
          "accelerationMode": "",
          "biEngineMode": "",
          "biEngineReasons": [
            {
              "code": null,
              "message": null
            }
          ]
        },
        "billingTier": 0,
        "cacheHit": false,
        "ddlAffectedRowAccessPolicyCount": "string",
        "ddlDestinationTable": {
          "datasetId": "string",
          "projectId": "string",
          "tableId": "string"
        },
        "ddlOperationPerformed": "string",
        "ddlTargetDataset": {
          "datasetId": "string",
          "projectId": "string"
        },
        "ddlTargetRoutine": {
          "datasetId": "string",
          "projectId": "string",
          "routineId": "string"
        },
        "ddlTargetRowAccessPolicy": {
          "datasetId": "string",
          "policyId": "string",
          "projectId": "string",
          "tableId": "string"
        },
        "ddlTargetTable": {
          "datasetId": "string",
          "projectId": "string",
          "tableId": "string"
        },
        "dmlStats": {
          "deletedRowCount": "string",
          "insertedRowCount": "string",
          "updatedRowCount": "string"
        },
        "estimatedBytesProcessed": "string"
      },
      "quotaDeferments": [
        "string"
      ],
      "reservationUsage": [
        {
          "name": "string",
          "slotMs": "string"
        }
      ]
    },
    "status": {
      "errorResult": {
        "debugInfo": "string",
        "location": "string",
        "message": "string",
        "reason": "string"
      },
      "errors": [
        {
          "debugInfo": "string",
          "location": "string",
          "message": "string",
          "reason": "string"
        }
      ],
      "state": "string"
    },
    "user_email": "string"
  },
  "kind": "bigquery#jobCancelResponse"
}

Need more? See the BigQuery guide for connection setup and behaviour shared by every action.

Was this page helpful?