Compute Engine v1 API - Class InstanceGroupManagerUpdatePolicy (2.3.0)

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

Inheritance

Object > InstanceGroupManagerUpdatePolicy

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

InstanceGroupManagerUpdatePolicy()

public InstanceGroupManagerUpdatePolicy()

InstanceGroupManagerUpdatePolicy(InstanceGroupManagerUpdatePolicy)

public InstanceGroupManagerUpdatePolicy(InstanceGroupManagerUpdatePolicy other)
Parameter
NameDescription
otherInstanceGroupManagerUpdatePolicy

Properties

HasInstanceRedistributionType

public bool HasInstanceRedistributionType { get; }

Gets whether the "instance_redistribution_type" field is set

Property Value
TypeDescription
Boolean

HasMinimalAction

public bool HasMinimalAction { get; }

Gets whether the "minimal_action" field is set

Property Value
TypeDescription
Boolean

HasMostDisruptiveAllowedAction

public bool HasMostDisruptiveAllowedAction { get; }

Gets whether the "most_disruptive_allowed_action" field is set

Property Value
TypeDescription
Boolean

HasReplacementMethod

public bool HasReplacementMethod { get; }

Gets whether the "replacement_method" field is set

Property Value
TypeDescription
Boolean

HasType

public bool HasType { get; }

Gets whether the "type" field is set

Property Value
TypeDescription
Boolean

InstanceRedistributionType

public string InstanceRedistributionType { get; set; }

The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. Check the InstanceRedistributionType enum for the list of possible values.

Property Value
TypeDescription
String

MaxSurge

public FixedOrPercent MaxSurge { get; set; }

The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

Property Value
TypeDescription
FixedOrPercent

MaxUnavailable

public FixedOrPercent MaxUnavailable { get; set; }

The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

Property Value
TypeDescription
FixedOrPercent

MinimalAction

public string MinimalAction { get; set; }

Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes. Check the MinimalAction enum for the list of possible values.

Property Value
TypeDescription
String

MostDisruptiveAllowedAction

public string MostDisruptiveAllowedAction { get; set; }

Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all. Check the MostDisruptiveAllowedAction enum for the list of possible values.

Property Value
TypeDescription
String

ReplacementMethod

public string ReplacementMethod { get; set; }

What action should be used to replace instances. See minimal_action.REPLACE Check the ReplacementMethod enum for the list of possible values.

Property Value
TypeDescription
String

Type

public string Type { get; set; }

The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls). Check the Type enum for the list of possible values.

Property Value
TypeDescription
String