Method: transferOperations.cancel

Cancels a transfer. Use the transferOperations.get method to check if the cancellation succeeded or if the operation completed despite the cancel request.

When you cancel an operation, the currently running transfer is interrupted. For recurring transfer jobs, the next instance of the transfer job will still run. For example, if your job is configured to run every day at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer will stop. However, a transfer job will still be attempted on Tuesday.

This applies only to currently running operations. If an operation is not currently running, cancel does nothing.

When you cancel a job, the next job computes a delta of files and may repair any inconsistent state. For instance, if you run a job every day, and today's job found 10 new files and transferred five files before you canceled the job, tomorrow's transfer operation will compute a new delta with the five files that were not copied today plus any new files discovered tomorrow.

HTTP request

POST https://storagetransfer.googleapis.com/v1/{name=transferOperations/**}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the operation resource to be cancelled.

Request body

The request body must be empty.

Response body

If successful, the response body will be empty.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.