public sealed class RolloutKind : IMessage<RolloutKind>, IEquatable<RolloutKind>, IDeepCloneable<RolloutKind>, IBufferMessage, IMessageReference documentation and code samples for the SaaS Runtime v1beta1 API class RolloutKind.
An object that describes various settings of Rollout execution. Includes built-in policies across GCP and GDC, and customizable policies.
Implements
IMessageRolloutKind, IEquatableRolloutKind, IDeepCloneableRolloutKind, IBufferMessage, IMessageNamespace
Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1Assembly
Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.dll
Constructors
RolloutKind()
public RolloutKind()RolloutKind(RolloutKind)
public RolloutKind(RolloutKind other)| Parameter | |
|---|---|
| Name | Description |
other |
RolloutKind |
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 |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. The timestamp when the resource was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
ErrorBudget
public ErrorBudget ErrorBudget { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
ErrorBudget |
|
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}/rolloutKinds/{rollout_kind_id}"
| Property Value | |
|---|---|
| Type | Description |
string |
|
RolloutKindName
public RolloutKindName RolloutKindName { get; set; }RolloutKindName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
RolloutKindName |
|
RolloutOrchestrationStrategy
public string RolloutOrchestrationStrategy { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
UnitKind
public string UnitKind { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
UnitKindAsUnitKindName
public UnitKindName UnitKindAsUnitKindName { get; set; }UnitKindName-typed view over the UnitKind resource name property.
| Property Value | |
|---|---|
| Type | Description |
UnitKindName |
|
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 |
|
UpdateUnitKindStrategy
public RolloutKind.Types.UpdateUnitKindStrategy UpdateUnitKindStrategy { get; set; }Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
| Property Value | |
|---|---|
| Type | Description |
RolloutKindTypesUpdateUnitKindStrategy |
|