Method: projects.locations.jobs.list

Lists all the batch jobs for a given project.

IAM Permissions:

Requires storagebatchoperations.jobs.list IAM permission on the project.

HTTP request

GET https://storagebatchoperations.googleapis.com/v1/{parent=projects/*/locations/global}/jobs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Format: projects/{projectId}/locations/global.

Query parameters

Parameters
filter

string

Optional. Filters results as defined by https://google.aip.dev/160.

pageSize

integer

Optional. The list page size. Default page size is 100.

pageToken

string

Optional. The list page token.

orderBy

string

Optional. Field to sort by. Supported fields are name, createTime.

Request body

The request body must be empty.

Response body

Response message to list batch jobs in a given project for a given location.

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

JSON representation
{
  "jobs": [
    {
      object (Job)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
jobs[]

object (Job)

A list of storage batch jobs.

nextPageToken

string

A token identifying a page of results.

unreachable[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.