Class RolloutKind
An object that describes various settings of Rollout execution. Includes built-in policies across GCP and GDC, and customizable policies.
Implements
Inherited Members
Namespace: Google.Apis.SaaSServiceManagement.v1beta1.Data
Assembly: Google.Apis.SaaSServiceManagement.v1beta1.dll
Syntax
public class RolloutKind : 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> |
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 |
ErrorBudget
Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
Declaration
[JsonProperty("errorBudget")]
public virtual ErrorBudget ErrorBudget { get; set; }
Property Value
| Type | Description |
|---|---|
| ErrorBudget |
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}/rolloutKinds/{rollout_kind_id}"
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
RolloutOrchestrationStrategy
Optional. The strategy used for executing a Rollout. This is a required field. 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 associated UnitKind's Saas Locations.
Declaration
[JsonProperty("rolloutOrchestrationStrategy")]
public virtual string RolloutOrchestrationStrategy { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
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.
Declaration
[JsonProperty("unitFilter")]
public virtual string UnitFilter { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
UnitKind
Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
Declaration
[JsonProperty("unitKind")]
public virtual string UnitKind { 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 |
UpdateUnitKindStrategy
Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
Declaration
[JsonProperty("updateUnitKindStrategy")]
public virtual string UpdateUnitKindStrategy { get; set; }
Property Value
| Type | Description |
|---|---|
| string |