Lists transfer jobs.
HTTP request
GET https://storagetransfer.googleapis.com/v1/transferJobs
The URL uses gRPC Transcoding syntax.
Query 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",...],
"dataBackend":"QUERY_REPLICATION_CONFIGS",
"sourceBucket":"source-bucket-name",
"sinkBucket":"sink-bucket-name",
}
The JSON formatting in the example is for display only; provide the query parameters without spaces or line breaks.
-
projectIdis required. - Since
jobNamesandjobStatusessupport multiple values, their values must be specified with array notation.jobNamesandjobStatusesare optional. Valid values are case-insensitive: - Specify
"dataBackend":"QUERY_REPLICATION_CONFIGS"to return a list of cross-bucket replication jobs. - Limit the results to jobs from a particular bucket with
sourceBucketand/or to a particular bucket withsinkBucket.
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 (
|
| Fields | |
|---|---|
transferJobs[]
|
A list of transfer jobs. |
nextPageToken
|
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 .
