Method: transferJobs.list

Lists transfer jobs.

HTTP request

GET https://storagetransfer.googleapis.com/v1/transferJobs

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
filter

string

Required. A list of query parameters specified as JSON text in the form of: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...]}

Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. projectId is required. jobNames and jobStatuses are optional. The valid values for jobStatuses are case-insensitive: ENABLED, DISABLED, and DELETED.

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

  • storagetransfer.jobs.list
pageSize

integer

The list page size. The max allowed value is 256.

pageToken

string

The list page token.

Request body

The request body must be empty.

Response body

Response from transferJobs.list.

If successful, the response body contains data with the following structure:

JSON representation
{
  "transferJobs": [
    {
      object (TransferJob)
    }
  ],
  "nextPageToken": string
}
Fields
transferJobs[]

object (TransferJob)

A list of transfer jobs.

nextPageToken

string

The list next page token.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.