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: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since job_names and job_statuses support multiple values, their values must be specified with array notation. project_id is required. job_names and job_statuses are optional. The valid values for job_statuses are case-insensitive: ENABLED, DISABLED, and DELETED.

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

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

Response from transferJobs.list.

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.