REST Resource: rollouts

Resource: Rollout

Rollout resource.

A Rollout is a specific instance of a RolloutPlan. It represents a single execution of a strategy to roll out a specific resource. It also provides APIs to interact with the rollout.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "rolloutEntity": {
    object (RolloutEntity)
  },
  "rolloutPlan": string,
  "state": enum (State),
  "etag": string,
  "currentWaveNumber": string,
  "waveDetails": [
    {
      object (WaveDetails)
    }
  ],
  "completionTime": string,
  "cancellationTime": string
}
Fields
kind

string

Output only. Type of the resource. Always

compute#rollout

for rollouts.
id

string (uint64 format)

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

string

Output only. Creation timestamp in RFC3339 text format.
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.
description

string

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

object (RolloutEntity)

Required. The resource being rolled out.
rolloutPlan

string

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

enum (State)

Output only. The current state of the Rollout.
etag

string

Output only. etag of the Rollout Ex. abc1234
currentWaveNumber

string (int64 format)

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

object (WaveDetails)

Output only. Details about each wave of the rollout.
completionTime

string

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

string

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

RolloutEntity

Specifications of the resource to roll out.

JSON representation 
{

  // Union field entity can be only one of the following:
  "orchestratedEntity": {
    object (OrchestratedEntity)
  }
  // End of list of possible types for union field entity.
}
Fields

Union field entity.

entity can be only one of the following:
orchestratedEntity

object (OrchestratedEntity)

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

OrchestratedEntity

This message is used if the resource type follows the Orchestrated integration model with ProgressiveRollout.

JSON representation 
{
  "orchestrationAction": string,
  "orchestrationSource": string,
  "conflictBehavior": string
}
Fields
orchestrationAction

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

string

Required. Fully qualified resource name of the resource which contains the source of truth of the configuration being rolled out across locations/projects. For example, in the case of a global Rollout which is applied across regions, this contains the name of the global resource created by the user which contains a payload for a resource that is orchestrated across regions. This follows the following format: //.googleapis.com/projects//locations/global// e.g. //osconfig.googleapis.com/projects/1/locations/global/policyOrchestrators/po1
conflictBehavior

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.

State

State of the Rollout.

Enums
STATE_UNSPECIFIED Undefined default state. Should never be exposed to users.
UNINITIALIZED The rollout has been created but is not yet ready to be started.
READY The rollout has been successfully initialized and is ready to start.
PROCESSING A wave is being processed by the product.
WAVE_FAILED The product failed to process the wave.
COMPLETING The rollout is being marked as completed.
COMPLETED The rollout is in a successful terminal state.
COMPLETE_FAILED An attempted complete operation was unsuccessful.
PAUSING The rollout is being paused.
PAUSED The rollout is paused.
PAUSE_FAILED An attempted pause operation was unsuccessful.
RESUMING The rollout is being resumed after being paused.
CANCELLING The rollout is being cancelled.
CANCELLED The rollout is in a failure terminal state.
CANCEL_FAILED An attempted cancel operation was unsuccessful.
ROLLING_BACK A wave rollback is in progress for this rollout.
ROLLBACK_WAVE_FAILED An attempted rollback operation failed to complete successfully.
FAILED The rollout completed with failures.

WaveDetails

Additional metadata about the status of each wave provided by the server.

JSON representation 
{
  "waveDisplayName": string,
  "waveNumber": string,

  // Union field details can be only one of the following:
  "orchestratedWaveDetails": {
    object (OrchestratedWaveDetails)
  }
  // End of list of possible types for union field details.
}
Fields
waveDisplayName

string

Output only. Wave name. Ex. wave1
waveNumber

string (int64 format)

Output only. System generated number for the wave.
Union field details. Additional details of the wave. details can be only one of the following:
orchestratedWaveDetails

object (OrchestratedWaveDetails)

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

OrchestratedWaveDetails

Details of the wave for products using the Orchestrated integration model.

JSON representation 
{
  "estimatedTotalResourcesCount": string,
  "completedResourcesCount": string,
  "failedResourcesCount": string,
  "failedLocations": [
    string
  ],
  "locationStatus": {
    string: {
      object (LocationStatus)
    },
    ...
  },
  "estimatedCompletionTime": string
}
Fields
estimatedTotalResourcesCount

string (int64 format)

Output only. Estimated total count of resources.
completedResourcesCount

string (int64 format)

Output only. Resource completed so far.
failedResourcesCount

string (int64 format)

Output only. Resources failed.
failedLocations[]

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

map (key: string, value: object (LocationStatus))

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

string

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

LocationStatus

Represents the status of a location in a wave.

JSON representation 
{
  "state": enum (LocationState)
}
Fields
state

enum (LocationState)

Output only. Location state of the wave.

LocationState

Represents the location state of a wave.

Enums
STATE_UNSPECIFIED Undefined default state. Should never be exposed to users.
STATE_PENDING Work on the wave is pending.
STATE_IN_PROGRESS Work on the wave is in progress.
STATE_SUCCEEDED Work on the wave succeeded.
STATE_FAILED Work on the wave failed.
STATE_SKIPPED Work on the wave was canceled or skipped.

Methods

cancel

 The method compute.v1.RolloutsService.Cancel is not available in Cloud de Confiance by S3NS.

delete

 The method compute.v1.RolloutsService.Delete is not available in Cloud de Confiance by S3NS.

get

 The method compute.v1.RolloutsService.Get is not available in Cloud de Confiance by S3NS.

list

 The method compute.v1.RolloutsService.List is not available in Cloud de Confiance by S3NS.