Class Rollout

Represents a single rollout execution and its results

Inheritance

object

Rollout

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.SaaSServiceManagement.v1beta1.Data

Assembly: Google.Apis.SaaSServiceManagement.v1beta1.dll

Syntax

public class Rollout : IDirectResponseSchema

Properties

Annotations

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations

Declaration

[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Control

Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state.

Declaration

[JsonProperty("control")]
public virtual RolloutControl Control { get; set; }

Property Value

Type	Description
RolloutControl

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. The timestamp when the resource was created.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

ETag

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

EffectiveUnitFilter

Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here.

Declaration

[JsonProperty("effectiveUnitFilter")]
public virtual string EffectiveUnitFilter { get; set; }

Property Value

Type	Description
string

EndTime

object representation of EndTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }

Property Value

Type	Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

EndTimeRaw

Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.

Declaration

[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }

Property Value

Type	Description
string

Labels

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Name

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}"

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

ParentRollout

Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"

Declaration

[JsonProperty("parentRollout")]
public virtual string ParentRollout { get; set; }

Property Value

Type	Description
string

Release

Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.

Declaration

[JsonProperty("release")]
public virtual string Release { get; set; }

Property Value

Type	Description
string

RolloutKind

Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.

Declaration

[JsonProperty("rolloutKind")]
public virtual string RolloutKind { get; set; }

Property Value

Type	Description
string

RolloutOrchestrationStrategy

Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.

Declaration

[JsonProperty("rolloutOrchestrationStrategy")]
public virtual string RolloutOrchestrationStrategy { get; set; }

Property Value

Type	Description
string

RootRollout

Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"

Declaration

[JsonProperty("rootRollout")]
public virtual string RootRollout { get; set; }

Property Value

Type	Description
string

StartTime

object representation of StartTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }

Property Value

Type	Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

StartTimeRaw

Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.

Declaration

[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }

Property Value

Type	Description
string

State

Output only. Current state of the rollout.

Declaration

[JsonProperty("state")]
public virtual string State { get; set; }

Property Value

Type	Description
string

StateMessage

Output only. Human readable message indicating details about the last state transition.

Declaration

[JsonProperty("stateMessage")]
public virtual string StateMessage { get; set; }

Property Value

Type	Description
string

StateTransitionTime

object representation of StateTransitionTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StateTransitionTimeDateTimeOffset instead.")]
public virtual object StateTransitionTime { get; set; }

Property Value

Type	Description
object

StateTransitionTimeDateTimeOffset

DateTimeOffset representation of StateTransitionTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? StateTransitionTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

StateTransitionTimeRaw

Optional. Output only. The time when the rollout transitioned into its current state.

Declaration

[JsonProperty("stateTransitionTime")]
public virtual string StateTransitionTimeRaw { get; set; }

Property Value

Type	Description
string

Stats

Optional. Output only. Details about the progress of the rollout.

Declaration

[JsonProperty("stats")]
public virtual RolloutStats Stats { get; set; }

Property Value

Type	Description
RolloutStats

Uid

Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

Declaration

[JsonProperty("uid")]
public virtual string Uid { get; set; }

Property Value

Type	Description
string

UnitFilter

Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used.

Declaration

[JsonProperty("unitFilter")]
public virtual string UnitFilter { get; set; }

Property Value

Type	Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema