Method: transferJobs.run

Starts a new operation for the specified transfer job. A TransferJob has a maximum of one active TransferOperation. If this method is called while a TransferOperation is active, an error is returned.

HTTP request

POST https://storagetransfer.googleapis.com/v1/{jobName=transferJobs/**}:run

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
jobName

string

Required. The name of the transfer job.

Authorization requires the following IAM permission on the specified resource jobName:

  • storagetransfer.jobs.run

Request body

The request body contains data with the following structure:

JSON representation
{
  "projectId": string
}
Fields
projectId

string

Required. The ID of the Google Cloud project that owns the transfer job.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.