Interface InstanceGroupManagerUpdatePolicyOrBuilder (1.40.0)

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.

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.

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.

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`

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.

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`

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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;

Implements

Methods

getInstanceRedistributionType()

getInstanceRedistributionTypeBytes()

getMaxSurge()

getMaxSurgeOrBuilder()

getMaxUnavailable()

getMaxUnavailableOrBuilder()

getMinimalAction()

getMinimalActionBytes()

getMostDisruptiveAllowedAction()

getMostDisruptiveAllowedActionBytes()

getReplacementMethod()

getReplacementMethodBytes()

getType()

getTypeBytes()

hasInstanceRedistributionType()

hasMaxSurge()

hasMaxUnavailable()

hasMinimalAction()

hasMostDisruptiveAllowedAction()

hasReplacementMethod()

hasType()