/

Console

• English
• Deutsch
• Español – América Latina
• Français
• Português – Brasil
• 中文 – 简体
• 日本語
• 한국어

Sign in

• Compute Engine

Start free

Method: rolloutPlans.list

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
  • JSON representation
    • JSON representation
      • JSON representation
      • JSON representation
      • JSON representation
      • JSON representation
    • JSON representation
• Authorization scopes
• Try it!

labels.owner:*

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

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

Response body

{
  "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
  ]
}

string

Output only. Unique identifier for the resource; defined by the server.

object

A list of RolloutPlan resources.

string

Output only. Type of the resource. Always compute#rolloutPlan for rolloutPlans.

string (uint64 format)

Output only. The unique identifier for the resource. This identifier is defined by the server.

string

Output only. Creation timestamp in RFC3339 text format.

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.

string

An optional description of this resource. Provide this property when you create the resource.

string

Output only. Server-defined fully-qualified URL for this resource.

string

Output only. Server-defined URL for this resource's resource id.

object

Required. The waves included in this rollout plan.

string

Optional. The display name of this wave of the rollout plan.

string (int64 format)

Output only. The wave number.

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.

object

Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.

string

Optional. Format: "organizations/{organizationId}"

string

Optional. Format: "folders/{folderId}"

string

Optional. Format: "projects/{projectId}"

object

Optional. Roll out to resources by Cloud locations.

string

Optional. Example: "us-central1-a"

object

Required. The validation to be performed at the end of this wave.

object

Optional. Metadata required if type = "time".

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".

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.

object

Optional. The orchestration options for this wave.

string (int64 format)

Optional. Maximum number of locations to be orchestrated in parallel.

string (int64 format)

Optional. Maximum number of resources to be orchestrated per location in parallel.

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.

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".

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.

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.

enum

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

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.

string

Output only. Server-defined URL for this resource.

object

Output only. Informational warning message.

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.

string

Output only. A human-readable description of the warning code.

object

Output only. Metadata about this warning in key: value format. For example:

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

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).

string

Output only. A warning data value corresponding to the key.

string

string