Class InstanceGroupManagerUpdatePolicy (1.32.0)

public final class InstanceGroupManagerUpdatePolicy extends GeneratedMessageV3 implements InstanceGroupManagerUpdatePolicyOrBuilder

Protobuf type google.cloud.compute.v1.InstanceGroupManagerUpdatePolicy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InstanceGroupManagerUpdatePolicy

Static Fields

INSTANCE_REDISTRIBUTION_TYPE_FIELD_NUMBER

public static final int INSTANCE_REDISTRIBUTION_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_SURGE_FIELD_NUMBER

public static final int MAX_SURGE_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_UNAVAILABLE_FIELD_NUMBER

public static final int MAX_UNAVAILABLE_FIELD_NUMBER
Field Value
TypeDescription
int

MINIMAL_ACTION_FIELD_NUMBER

public static final int MINIMAL_ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

MOST_DISRUPTIVE_ALLOWED_ACTION_FIELD_NUMBER

public static final int MOST_DISRUPTIVE_ALLOWED_ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

REPLACEMENT_METHOD_FIELD_NUMBER

public static final int REPLACEMENT_METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static InstanceGroupManagerUpdatePolicy getDefaultInstance()
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static InstanceGroupManagerUpdatePolicy.Builder newBuilder()
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy.Builder

newBuilder(InstanceGroupManagerUpdatePolicy prototype)

public static InstanceGroupManagerUpdatePolicy.Builder newBuilder(InstanceGroupManagerUpdatePolicy prototype)
Parameter
NameDescription
prototypeInstanceGroupManagerUpdatePolicy
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy.Builder

parseDelimitedFrom(InputStream input)

public static InstanceGroupManagerUpdatePolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManagerUpdatePolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static InstanceGroupManagerUpdatePolicy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManagerUpdatePolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InstanceGroupManagerUpdatePolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManagerUpdatePolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InstanceGroupManagerUpdatePolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManagerUpdatePolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static InstanceGroupManagerUpdatePolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManagerUpdatePolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static InstanceGroupManagerUpdatePolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManagerUpdatePolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<InstanceGroupManagerUpdatePolicy> parser()
Returns
TypeDescription
Parser<InstanceGroupManagerUpdatePolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public InstanceGroupManagerUpdatePolicy getDefaultInstanceForType()
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy

getInstanceRedistributionType()

public String getInstanceRedistributionType()

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.

optional string instance_redistribution_type = 292630424;

Returns
TypeDescription
String

The instanceRedistributionType.

getInstanceRedistributionTypeBytes()

public ByteString getInstanceRedistributionTypeBytes()

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.

optional string instance_redistribution_type = 292630424;

Returns
TypeDescription
ByteString

The bytes for instanceRedistributionType.

getMaxSurge()

public FixedOrPercent getMaxSurge()

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.

optional .google.cloud.compute.v1.FixedOrPercent max_surge = 302572691;

Returns
TypeDescription
FixedOrPercent

The maxSurge.

getMaxSurgeOrBuilder()

public FixedOrPercentOrBuilder getMaxSurgeOrBuilder()

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.

optional .google.cloud.compute.v1.FixedOrPercent max_surge = 302572691;

Returns
TypeDescription
FixedOrPercentOrBuilder

getMaxUnavailable()

public FixedOrPercent getMaxUnavailable()

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.

optional .google.cloud.compute.v1.FixedOrPercent max_unavailable = 404940277;

Returns
TypeDescription
FixedOrPercent

The maxUnavailable.

getMaxUnavailableOrBuilder()

public FixedOrPercentOrBuilder getMaxUnavailableOrBuilder()

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.

optional .google.cloud.compute.v1.FixedOrPercent max_unavailable = 404940277;

Returns
TypeDescription
FixedOrPercentOrBuilder

getMinimalAction()

public String getMinimalAction()

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.

optional string minimal_action = 270567060;

Returns
TypeDescription
String

The minimalAction.

getMinimalActionBytes()

public ByteString getMinimalActionBytes()

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.

optional string minimal_action = 270567060;

Returns
TypeDescription
ByteString

The bytes for minimalAction.

getMostDisruptiveAllowedAction()

public String getMostDisruptiveAllowedAction()

Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to avoid restarting the VM and to limit disruption as much as possible. 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.

optional string most_disruptive_allowed_action = 66103053;

Returns
TypeDescription
String

The mostDisruptiveAllowedAction.

getMostDisruptiveAllowedActionBytes()

public ByteString getMostDisruptiveAllowedActionBytes()

Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to avoid restarting the VM and to limit disruption as much as possible. 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.

optional string most_disruptive_allowed_action = 66103053;

Returns
TypeDescription
ByteString

The bytes for mostDisruptiveAllowedAction.

getParserForType()

public Parser<InstanceGroupManagerUpdatePolicy> getParserForType()
Returns
TypeDescription
Parser<InstanceGroupManagerUpdatePolicy>
Overrides

getReplacementMethod()

public String getReplacementMethod()

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

optional string replacement_method = 505931694;

Returns
TypeDescription
String

The replacementMethod.

getReplacementMethodBytes()

public ByteString getReplacementMethodBytes()

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

optional string replacement_method = 505931694;

Returns
TypeDescription
ByteString

The bytes for replacementMethod.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getType()

public String getType()

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.

optional string type = 3575610;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

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.

optional string type = 3575610;

Returns
TypeDescription
ByteString

The bytes for type.

hasInstanceRedistributionType()

public boolean hasInstanceRedistributionType()

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.

optional string instance_redistribution_type = 292630424;

Returns
TypeDescription
boolean

Whether the instanceRedistributionType field is set.

hasMaxSurge()

public boolean hasMaxSurge()

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.

optional .google.cloud.compute.v1.FixedOrPercent max_surge = 302572691;

Returns
TypeDescription
boolean

Whether the maxSurge field is set.

hasMaxUnavailable()

public boolean hasMaxUnavailable()

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.

optional .google.cloud.compute.v1.FixedOrPercent max_unavailable = 404940277;

Returns
TypeDescription
boolean

Whether the maxUnavailable field is set.

hasMinimalAction()

public boolean hasMinimalAction()

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.

optional string minimal_action = 270567060;

Returns
TypeDescription
boolean

Whether the minimalAction field is set.

hasMostDisruptiveAllowedAction()

public boolean hasMostDisruptiveAllowedAction()

Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to avoid restarting the VM and to limit disruption as much as possible. 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.

optional string most_disruptive_allowed_action = 66103053;

Returns
TypeDescription
boolean

Whether the mostDisruptiveAllowedAction field is set.

hasReplacementMethod()

public boolean hasReplacementMethod()

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

optional string replacement_method = 505931694;

Returns
TypeDescription
boolean

Whether the replacementMethod field is set.

hasType()

public boolean hasType()

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.

optional string type = 3575610;

Returns
TypeDescription
boolean

Whether the type field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public InstanceGroupManagerUpdatePolicy.Builder newBuilderForType()
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InstanceGroupManagerUpdatePolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public InstanceGroupManagerUpdatePolicy.Builder toBuilder()
Returns
TypeDescription
InstanceGroupManagerUpdatePolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException