Method: projects.locations.deliveryPipelines.releases.rollouts.list

Lists Rollouts in a given project and location.

HTTP request

GET https://clouddeploy.googleapis.com/v1/{parent=projects/*/locations/*/deliveryPipelines/*/releases/*}/rollouts

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The Release which owns this collection of Rollout objects.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of Rollout objects to return. The service may return fewer than this value. If unspecified, at most 50 Rollout objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
pageToken

string

Optional. A page token, received from a previous rollouts.list call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.
filter

string

Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.
orderBy

string

Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Request body

The request body must be empty.

Response body

ListRolloutsResponse is the response object reutrned by rollouts.list.

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

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

object (Rollout)

The Rollout objects.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
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.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • clouddeploy.rollouts.list

For more information, see the IAM documentation.