Method: projects.locations.rollouts.list

Retrieve the list of all rollouts.

HTTP request

GET https://gkehub.googleapis.com/v1alpha/{parent=projects/*/locations/*}/rollouts

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of rollout. Format: projects/{project}/locations/{location}

Query parameters

Parameters
pageSize

integer

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

string

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

When paginating, all other parameters provided to rollouts.list must match the call that provided the page token.
filter

string

Optional. Lists Rollouts that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

Request body

The request body must be empty.

Response body

Response message for listing rollouts.

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

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

object (Rollout)

The rollouts from the specified parent resource.
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.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.