Method: rolloutPlans.list

Lists RolloutPlans in a given project and location.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/rolloutPlans

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

integer (uint32 format)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
pageToken

string

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
filter

string

A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

labels.owner:*

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example:

(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

You cannot combine constraints on multiple fields using regular expressions.
orderBy

string

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.
returnPartialSuccess

boolean

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

Contains a list of RolloutPlan resources.

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

JSON representation 
{
  "id": string,
  "items": [
    {
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "selfLink": string,
      "selfLinkWithId": string,
      "waves": [
        {
          "displayName": string,
          "number": string,
          "selectors": [
            {
              "resourceHierarchySelector": {
                "includedOrganizations": [
                  string
                ],
                "includedFolders": [
                  string
                ],
                "includedProjects": [
                  string
                ]
              },
              "locationSelector": {
                "includedLocations": [
                  string
                ]
              }
            }
          ],
          "validation": {
            "timeBasedValidationMetadata": {
              "waitDuration": string
            },
            "type": string
          },
          "orchestrationOptions": {
            "maxConcurrentLocations": string,
            "maxConcurrentResourcesPerLocation": string,
            "delays": [
              {
                "duration": string,
                "delimiter": enum,
                "type": enum
              }
            ]
          }
        }
      ],
      "locationScope": enum
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "etag": string,
  "unreachables": [
    string
  ]
}
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items[]

object

A list of RolloutPlan resources.
items[].kind

string

[Output Only] Type of the resource. Always compute#rolloutPlan for rolloutPlans.
items[].id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
items[].creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
items[].name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
items[].description

string

An optional description of this resource. Provide this property when you create the resource.
items[].selfLink

string

[Output Only] Server-defined fully-qualified URL for this resource.
items[].selfLinkWithId

string

[Output Only] Server-defined URL for this resource's resource id.
items[].waves[]

object

Required. The waves included in this rollout plan.
items[].waves[].displayName

string

Optional. The display name of this wave of the rollout plan.
items[].waves[].number

string (int64 format)

Output only. The wave number.
items[].waves[].selectors[]

object

Required. The selectors for this wave. There is a logical AND between each selector defined in a wave, so a resource must satisfy the criteria of all the specified selectors to be in scope for the wave.
items[].waves[].selectors[].resourceHierarchySelector

object

Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
items[].waves[].selectors[].resourceHierarchySelector.includedOrganizations[]

string

Optional. Format: "organizations/{organizationId}"
items[].waves[].selectors[].resourceHierarchySelector.includedFolders[]

string

Optional. Format: "folders/{folderId}"
items[].waves[].selectors[].resourceHierarchySelector.includedProjects[]

string

Optional. Format: "projects/{projectId}"
items[].waves[].selectors[].locationSelector

object

Optional. Roll out to resources by Cloud locations.
items[].waves[].selectors[].locationSelector.includedLocations[]

string

Optional. Example: "us-central1-a"
items[].waves[].validation

object

Required. The validation to be performed at the end of this wave.
items[].waves[].validation.timeBasedValidationMetadata

object

Optional. Metadata required if type = "time".
items[].waves[].validation.timeBasedValidationMetadata.waitDuration

string (Duration format)

Optional. The duration that the system waits in between waves. This wait starts after all changes in the wave are rolled out.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
items[].waves[].validation.type

string

Required. The type of the validation. If a type of validation is associated with a metadata object, the appropriate metadata field mapping to the validation type must be provided in the validation message. Possible values are in quotes below alongside an explanation: "manual": The system waits for an end-user approval API before progressing to the next wave. "time": The system waits for a user specified duration before progressing to the next wave. TimeBasedValidation must be provided.
items[].waves[].orchestrationOptions

object

Optional. The orchestration options for this wave.
items[].waves[].orchestrationOptions.maxConcurrentLocations

string (int64 format)

Optional. Maximum number of locations to be orchestrated in parallel.
items[].waves[].orchestrationOptions.maxConcurrentResourcesPerLocation

string (int64 format)

Optional. Maximum number of resources to be orchestrated per location in parallel.
items[].waves[].orchestrationOptions.delays[]

object

Optional. Delays, if any, to be added between batches of projects. We allow multiple Delays to be specified, letting users set separate delays between batches of projects corresponding to different locations and batches of projects corresponding to the same location.
items[].waves[].orchestrationOptions.delays[].duration

string (Duration format)

Optional. The duration of the delay, if any, to be added between batches of projects. A zero duration corresponds to no delay.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
items[].waves[].orchestrationOptions.delays[].delimiter

enum

Optional. Controls whether the delay should only be added between batches of projects corresponding to different locations, or also between batches of projects corresponding to the same location.

Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
items[].waves[].orchestrationOptions.delays[].type

enum

Optional. Controls whether the specified duration is to be added at the end of each batch, or if the total processing time for each batch will be padded if needed to meet the specified duration.

Must be set to TYPE_UNSPECIFIED if no delay is to be added.
items[].locationScope

enum

The location scope of the rollout plan. If not specified, the location scope is considered as ZONAL.
nextPageToken

string

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
warning

object

[Output Only] Informational warning message.
warning.code

enum

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.message

string

[Output Only] A human-readable description of the warning code.
warning.data[]

object

[Output Only] Metadata about this warning in key: value format. For example: 

"data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
warning.data[].key

string

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value

string

[Output Only] A warning data value corresponding to the key.
etag

string
unreachables[]

string

[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.