Method: projects.transferConfigs.runs.cancel

Cancels a data transfer run. Marks run as cancelled. It is up to the data source to decide at which point the transfer run is cancelled. Only supported for batch data sources. Unlike delete, it retains the transfer run and just sets the transfer run status to CANCELLED, so that data source can stop ingesting data (if that is possible).

HTTP request

POST https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*/transferConfigs/*/runs/*}:cancel

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
name

string

The field will contain the name of the resource requested, for example: projects/{projectId}/transferConfigs/{config_id}/runs/{run_id}

Request body

The request body must be empty.

Response body

If successful, the response body will be empty.

Authorization

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/bigquery

For more information, see the Auth Guide.

Send feedback about...