public final class InstanceGroupManagerUpdatePolicy extends GeneratedMessageV3 implements InstanceGroupManagerUpdatePolicyOrBuilder
Protobuf type google.cloud.compute.v1.InstanceGroupManagerUpdatePolicy
Static Fields
INSTANCE_REDISTRIBUTION_TYPE_FIELD_NUMBER
public static final int INSTANCE_REDISTRIBUTION_TYPE_FIELD_NUMBER
Field Value
MAX_SURGE_FIELD_NUMBER
public static final int MAX_SURGE_FIELD_NUMBER
Field Value
MAX_UNAVAILABLE_FIELD_NUMBER
public static final int MAX_UNAVAILABLE_FIELD_NUMBER
Field Value
MINIMAL_ACTION_FIELD_NUMBER
public static final int MINIMAL_ACTION_FIELD_NUMBER
Field Value
MOST_DISRUPTIVE_ALLOWED_ACTION_FIELD_NUMBER
public static final int MOST_DISRUPTIVE_ALLOWED_ACTION_FIELD_NUMBER
Field Value
REPLACEMENT_METHOD_FIELD_NUMBER
public static final int REPLACEMENT_METHOD_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static InstanceGroupManagerUpdatePolicy getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static InstanceGroupManagerUpdatePolicy.Builder newBuilder()
Returns
newBuilder(InstanceGroupManagerUpdatePolicy prototype)
public static InstanceGroupManagerUpdatePolicy.Builder newBuilder(InstanceGroupManagerUpdatePolicy prototype)
Parameter
Returns
public static InstanceGroupManagerUpdatePolicy parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static InstanceGroupManagerUpdatePolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static InstanceGroupManagerUpdatePolicy parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupManagerUpdatePolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static InstanceGroupManagerUpdatePolicy parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupManagerUpdatePolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static InstanceGroupManagerUpdatePolicy parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static InstanceGroupManagerUpdatePolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static InstanceGroupManagerUpdatePolicy parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static InstanceGroupManagerUpdatePolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static InstanceGroupManagerUpdatePolicy parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupManagerUpdatePolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<InstanceGroupManagerUpdatePolicy> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public InstanceGroupManagerUpdatePolicy getDefaultInstanceForType()
Returns
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;
| Type | Description |
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;
| Type | Description |
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;
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;
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;
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;
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;
| Type | Description |
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;
| Type | Description |
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 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.
optional string most_disruptive_allowed_action = 66103053;
| Type | Description |
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 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.
optional string most_disruptive_allowed_action = 66103053;
| Type | Description |
ByteString | The bytes for mostDisruptiveAllowedAction.
|
getParserForType()
public Parser<InstanceGroupManagerUpdatePolicy> getParserForType()
Returns
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;
| Type | Description |
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;
| Type | Description |
ByteString | The bytes for replacementMethod.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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;
| Type | Description |
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
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;
| Type | Description |
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;
| Type | Description |
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;
| Type | Description |
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 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.
optional string most_disruptive_allowed_action = 66103053;
| Type | Description |
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;
| Type | Description |
boolean | Whether the replacementMethod field is set.
|
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;
| Type | Description |
boolean | Whether the type field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public InstanceGroupManagerUpdatePolicy.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected InstanceGroupManagerUpdatePolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public InstanceGroupManagerUpdatePolicy.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
