Compute Engine v1 API - Class Rollout (3.28.0)

public sealed class Rollout : IMessage<Rollout>, IEquatable<Rollout>, IDeepCloneable<Rollout>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class 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.

Inheritance

object > Rollout

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

Rollout()

public Rollout()

Rollout(Rollout)

public Rollout(Rollout other)
Parameter
Name Description
other Rollout

Properties

CancellationTime

public string CancellationTime { get; set; }

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

Property Value
Type Description
string

CompletionTime

public string CompletionTime { get; set; }

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

Property Value
Type Description
string

CreationTimestamp

public string CreationTimestamp { get; set; }

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Property Value
Type Description
string

CurrentWaveNumber

public long CurrentWaveNumber { get; set; }

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

Property Value
Type Description
long

Description

public string Description { get; set; }

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

Property Value
Type Description
string

Etag

public string Etag { get; set; }

Output only. etag of the Rollout Ex. abc1234

Property Value
Type Description
string

HasCancellationTime

public bool HasCancellationTime { get; }

Gets whether the "cancellation_time" field is set

Property Value
Type Description
bool

HasCompletionTime

public bool HasCompletionTime { get; }

Gets whether the "completion_time" field is set

Property Value
Type Description
bool

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
Type Description
bool

HasCurrentWaveNumber

public bool HasCurrentWaveNumber { get; }

Gets whether the "current_wave_number" field is set

Property Value
Type Description
bool

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type Description
bool

HasEtag

public bool HasEtag { get; }

Gets whether the "etag" field is set

Property Value
Type Description
bool

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
Type Description
bool

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type Description
bool

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type Description
bool

HasRolloutPlan

public bool HasRolloutPlan { get; }

Gets whether the "rollout_plan" field is set

Property Value
Type Description
bool
public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
Type Description
bool

HasSelfLinkWithId

public bool HasSelfLinkWithId { get; }

Gets whether the "self_link_with_id" field is set

Property Value
Type Description
bool

HasState

public bool HasState { get; }

Gets whether the "state" field is set

Property Value
Type Description
bool

Id

public ulong Id { get; set; }

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

Property Value
Type Description
ulong

Kind

public string Kind { get; set; }

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

Property Value
Type Description
string

Name

public string Name { get; set; }

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

Property Value
Type Description
string

RolloutEntity

public RolloutRolloutEntity RolloutEntity { get; set; }

Required. The resource being rolled out.

Property Value
Type Description
RolloutRolloutEntity

RolloutPlan

public string RolloutPlan { get; set; }

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

Property Value
Type Description
string
public string SelfLink { get; set; }

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

Property Value
Type Description
string

SelfLinkWithId

public string SelfLinkWithId { get; set; }

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

Property Value
Type Description
string

State

public string State { get; set; }

Output only. The current state of the Rollout. Check the State enum for the list of possible values.

Property Value
Type Description
string

WaveDetails

public RepeatedField<RolloutWaveDetails> WaveDetails { get; }

Output only. Details about each wave of the rollout.

Property Value
Type Description
RepeatedFieldRolloutWaveDetails