/

Console

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

Sign in

• Compute Engine

Start free

REST Resource: organizationRollouts

• Resource: OrganizationRolloutsGetResponse
  • JSON representation
    • JSON representation
    • JSON representation
• Methods

{
  "resource": {
    "kind": string,
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "description": string,
    "selfLink": string,
    "selfLinkWithId": string,
    "rolloutEntity": {

      // Union field entity can be only one of the following:
      "orchestratedEntity": {
        "orchestrationAction": string,
        "orchestrationSource": string,
        "conflictBehavior": string
      }
      // End of list of possible types for union field entity.
    },
    "rolloutPlan": string,
    "state": enum,
    "etag": string,
    "currentWaveNumber": string,
    "waveDetails": [
      {
        "waveDisplayName": string,
        "waveNumber": string,

        // Union field details can be only one of the following:
        "orchestratedWaveDetails": {
          "estimatedTotalResourcesCount": string,
          "completedResourcesCount": string,
          "failedResourcesCount": string,
          "failedLocations": [
            string
          ],
          "locationStatus": {
            string: {
              "state": enum
            },
            ...
          },
          "estimatedCompletionTime": string
        }
        // End of list of possible types for union field details.
      }
    ],
    "completionTime": string,
    "cancellationTime": string,
    "pauseTime": string,
    "resumeTime": string
  },
  "etag": string
}

object

string

Output only. Type of the resource. Always compute#rollout for rollouts.

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 resource being rolled out.

object

Optional. Entity details for products using the Orchestrated Integration model.

string

Required. Orchestration action during the Rollout. It can be one of the following values: 1) "update": Resources will be updated by the rollout. 2) "delete": Resources will be deleted by the rollout.

string

string

Required. Specifies the behavior of the Rollout if an out of band update is detected in a project during a Rollout. It can be one of the following values: 1) overwrite : Overwrite the local value with the rollout value. 2) no_overwrite : Do not overwrite the local value with the rollout value.

string

Required. Rollout Plan used to model the Rollout. Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1

enum

Output only. The current state of the Rollout.

string

Output only. etag of the Rollout Ex. abc1234

string (int64 format)

Output only. The number of the currently running wave. Ex. 1

object

Output only. Details about each wave of the rollout.

object

Output only. Additional details of the wave for products using the Orchestrated Integration model.

string (int64 format)

Output only. Estimated total count of resources.

string (int64 format)

Output only. Resource completed so far.

string (int64 format)

Output only. Resources failed.

string

Output only. Locations that failed during orchestration, and ProgressiveRollout stopped retrying. There may be some successful resources rolled out in the wave as the location may have failed later in the Rollout.

map (key: string, value: object)

Output only. Status of each location in the wave. Map keys (locations) must be specified like "us-east1" or "asia-west1-a".

enum

Output only. Location state of the wave.

string

Output only. Estimated timestamp at which the wave will complete. Extrapolated from current progress.

string

Output only. Wave name. Ex. wave1

string (int64 format)

Output only. System generated number for the wave.

string

Output only. The timestamp at which the Rollout was completed.

string

Output only. The timestamp at which the Rollout was cancelled.

string

Output only. The timestamp at which the Rollout was paused.

string

Output only. The timestamp at which the Rollout was resumed.

string