public sealed class Rollout : IMessage<Rollout>, IEquatable<Rollout>, IDeepCloneable<Rollout>, IBufferMessage, IMessageReference documentation and code samples for the SaaS Runtime v1beta1 API class Rollout.
Represents a single rollout execution and its results
Namespace
Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1Assembly
Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.dll
Constructors
Rollout()
public Rollout()Rollout(Rollout)
public Rollout(Rollout other)| Parameter | |
|---|---|
| Name | Description |
other |
Rollout |
Properties
Annotations
public MapField<string, string> Annotations { get; }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
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Control
public RolloutControl Control { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
RolloutControl |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. The timestamp when the resource was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
EndTime
public Timestamp EndTime { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Etag
public string Etag { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Labels
public MapField<string, string> Labels { get; }Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Name
public string Name { get; set; }Identifier. The resource name (full URI of the resource) following the standard naming scheme:
"projects/{project}/locations/{location}/rollout/{rollout_id}"
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParentRollout
public string ParentRollout { get; set; }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}"
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParentRolloutAsRolloutName
public RolloutName ParentRolloutAsRolloutName { get; set; }RolloutName-typed view over the ParentRollout resource name property.
| Property Value | |
|---|---|
| Type | Description |
RolloutName |
|
Release
public string Release { get; set; }Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ReleaseAsReleaseName
public ReleaseName ReleaseAsReleaseName { get; set; }ReleaseName-typed view over the Release resource name property.
| Property Value | |
|---|---|
| Type | Description |
ReleaseName |
|
RolloutKind
public string RolloutKind { get; set; }Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.
| Property Value | |
|---|---|
| Type | Description |
string |
|
RolloutKindAsRolloutKindName
public RolloutKindName RolloutKindAsRolloutKindName { get; set; }RolloutKindName-typed view over the RolloutKind resource name property.
| Property Value | |
|---|---|
| Type | Description |
RolloutKindName |
|
RolloutName
public RolloutName RolloutName { get; set; }RolloutName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
RolloutName |
|
RolloutOrchestrationStrategy
public string RolloutOrchestrationStrategy { get; set; }Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutType. If not specified on creation, the strategy from RolloutType 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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
RootRollout
public string RootRollout { get; set; }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}"
| Property Value | |
|---|---|
| Type | Description |
string |
|
RootRolloutAsRolloutName
public RolloutName RootRolloutAsRolloutName { get; set; }RolloutName-typed view over the RootRollout resource name property.
| Property Value | |
|---|---|
| Type | Description |
RolloutName |
|
StartTime
public Timestamp StartTime { get; set; }Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
State
public Rollout.Types.RolloutState State { get; set; }Output only. Current state of the rollout.
| Property Value | |
|---|---|
| Type | Description |
RolloutTypesRolloutState |
|
StateMessage
public string StateMessage { get; set; }Output only. Human readable message indicating details about the last state transition.
| Property Value | |
|---|---|
| Type | Description |
string |
|
StateTransitionTime
public Timestamp StateTransitionTime { get; set; }Optional. Output only. The time when the rollout transitioned into its current state.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Stats
public RolloutStats Stats { get; set; }Optional. Output only. Details about the progress of the rollout.
| Property Value | |
|---|---|
| Type | Description |
RolloutStats |
|
Uid
public string Uid { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
UnitFilter
public string UnitFilter { get; set; }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 RolloutType will be used.
| Property Value | |
|---|---|
| Type | Description |
string |
|
UpdateTime
public Timestamp UpdateTime { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|