- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class InstanceGroupManagerUpdatePolicy.Builder extends GeneratedMessageV3.Builder<InstanceGroupManagerUpdatePolicy.Builder> implements InstanceGroupManagerUpdatePolicyOrBuilder Protobuf type google.cloud.compute.v1.InstanceGroupManagerUpdatePolicy
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > InstanceGroupManagerUpdatePolicy.BuilderImplements
InstanceGroupManagerUpdatePolicyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public InstanceGroupManagerUpdatePolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
build()
public InstanceGroupManagerUpdatePolicy build()| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy | |
buildPartial()
public InstanceGroupManagerUpdatePolicy buildPartial()| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy | |
clear()
public InstanceGroupManagerUpdatePolicy.Builder clear()| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
clearField(Descriptors.FieldDescriptor field)
public InstanceGroupManagerUpdatePolicy.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
clearInstanceRedistributionType()
public InstanceGroupManagerUpdatePolicy.Builder clearInstanceRedistributionType()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 | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
clearMaxSurge()
public InstanceGroupManagerUpdatePolicy.Builder clearMaxSurge()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 | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
clearMaxUnavailable()
public InstanceGroupManagerUpdatePolicy.Builder clearMaxUnavailable()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 | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
clearMinimalAction()
public InstanceGroupManagerUpdatePolicy.Builder clearMinimalAction()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 | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
clearMostDisruptiveAllowedAction()
public InstanceGroupManagerUpdatePolicy.Builder clearMostDisruptiveAllowedAction()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 | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public InstanceGroupManagerUpdatePolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
clearReplacementMethod()
public InstanceGroupManagerUpdatePolicy.Builder clearReplacementMethod()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 | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
clearType()
public InstanceGroupManagerUpdatePolicy.Builder clearType()The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update. Check the Type enum for the list of possible values.
optional string type = 3575610;
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
clone()
public InstanceGroupManagerUpdatePolicy.Builder clone()| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
getDefaultInstanceForType()
public InstanceGroupManagerUpdatePolicy getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
FixedOrPercent | The maxSurge. |
getMaxSurgeBuilder()
public FixedOrPercent.Builder getMaxSurgeBuilder()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 | |
|---|---|
| Type | Description |
FixedOrPercent.Builder | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
FixedOrPercent | The maxUnavailable. |
getMaxUnavailableBuilder()
public FixedOrPercent.Builder getMaxUnavailableBuilder()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 | |
|---|---|
| Type | Description |
FixedOrPercent.Builder | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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 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 | |
|---|---|
| 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 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for mostDisruptiveAllowedAction. |
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 | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for replacementMethod. |
getType()
public String getType()The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update. Check the Type enum for the list of possible values.
optional string type = 3575610;
| Returns | |
|---|---|
| Type | Description |
String | The type. |
getTypeBytes()
public ByteString getTypeBytes()The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update. Check the Type enum for the list of possible values.
optional string type = 3575610;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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 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 | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the replacementMethod field is set. |
hasType()
public boolean hasType()The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update. Check the Type enum for the list of possible values.
optional string type = 3575610;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the type field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(InstanceGroupManagerUpdatePolicy other)
public InstanceGroupManagerUpdatePolicy.Builder mergeFrom(InstanceGroupManagerUpdatePolicy other)| Parameter | |
|---|---|
| Name | Description |
other | InstanceGroupManagerUpdatePolicy |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public InstanceGroupManagerUpdatePolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public InstanceGroupManagerUpdatePolicy.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
mergeMaxSurge(FixedOrPercent value)
public InstanceGroupManagerUpdatePolicy.Builder mergeMaxSurge(FixedOrPercent value)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;
| Parameter | |
|---|---|
| Name | Description |
value | FixedOrPercent |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
mergeMaxUnavailable(FixedOrPercent value)
public InstanceGroupManagerUpdatePolicy.Builder mergeMaxUnavailable(FixedOrPercent value)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;
| Parameter | |
|---|---|
| Name | Description |
value | FixedOrPercent |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final InstanceGroupManagerUpdatePolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public InstanceGroupManagerUpdatePolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
setInstanceRedistributionType(String value)
public InstanceGroupManagerUpdatePolicy.Builder setInstanceRedistributionType(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe instanceRedistributionType to set. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
setInstanceRedistributionTypeBytes(ByteString value)
public InstanceGroupManagerUpdatePolicy.Builder setInstanceRedistributionTypeBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for instanceRedistributionType to set. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
setMaxSurge(FixedOrPercent value)
public InstanceGroupManagerUpdatePolicy.Builder setMaxSurge(FixedOrPercent value)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;
| Parameter | |
|---|---|
| Name | Description |
value | FixedOrPercent |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
setMaxSurge(FixedOrPercent.Builder builderForValue)
public InstanceGroupManagerUpdatePolicy.Builder setMaxSurge(FixedOrPercent.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | FixedOrPercent.Builder |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
setMaxUnavailable(FixedOrPercent value)
public InstanceGroupManagerUpdatePolicy.Builder setMaxUnavailable(FixedOrPercent value)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;
| Parameter | |
|---|---|
| Name | Description |
value | FixedOrPercent |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
setMaxUnavailable(FixedOrPercent.Builder builderForValue)
public InstanceGroupManagerUpdatePolicy.Builder setMaxUnavailable(FixedOrPercent.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | FixedOrPercent.Builder |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
setMinimalAction(String value)
public InstanceGroupManagerUpdatePolicy.Builder setMinimalAction(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe minimalAction to set. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
setMinimalActionBytes(ByteString value)
public InstanceGroupManagerUpdatePolicy.Builder setMinimalActionBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for minimalAction to set. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
setMostDisruptiveAllowedAction(String value)
public InstanceGroupManagerUpdatePolicy.Builder setMostDisruptiveAllowedAction(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe mostDisruptiveAllowedAction to set. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
setMostDisruptiveAllowedActionBytes(ByteString value)
public InstanceGroupManagerUpdatePolicy.Builder setMostDisruptiveAllowedActionBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for mostDisruptiveAllowedAction to set. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public InstanceGroupManagerUpdatePolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |
setReplacementMethod(String value)
public InstanceGroupManagerUpdatePolicy.Builder setReplacementMethod(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe replacementMethod to set. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
setReplacementMethodBytes(ByteString value)
public InstanceGroupManagerUpdatePolicy.Builder setReplacementMethodBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for replacementMethod to set. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
setType(String value)
public InstanceGroupManagerUpdatePolicy.Builder setType(String value)The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update. Check the Type enum for the list of possible values.
optional string type = 3575610;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe type to set. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
setTypeBytes(ByteString value)
public InstanceGroupManagerUpdatePolicy.Builder setTypeBytes(ByteString value)The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update. Check the Type enum for the list of possible values.
optional string type = 3575610;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for type to set. |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final InstanceGroupManagerUpdatePolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerUpdatePolicy.Builder | |