Method: transferOperations.list

Lists transfer operations. Operations are ordered by their creation time in reverse chronological order.

HTTP request

GET https://storagetransfer.googleapis.com/v1/{name}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Not used.

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",...], "operationNames":["opid1","opid2",...], "transferStatuses":["status1","status2",...]}

Since jobNames, operationNames, and transferStatuses support multiple values, they must be specified with array notation. projectId is required. jobNames, operationNames, and transferStatuses are optional. The valid values for transferStatuses are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.

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:

The response message for Operations.ListOperations.

JSON representation
{
  "operations": [
    {
      object (Operation)
    }
  ],
  "nextPageToken": string
}
Fields
operations[]

object (Operation)

A list of operations that matches the specified filter in the request.

nextPageToken

string

The standard 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.