# Compute V1 Client - Class InstanceGroupManagerUpdatePolicy (2.10.0)

2.10.0 (latest) 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.1 2.0.0 1.36.0 1.35.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.1 1.21.0 1.20.0 1.19.0 1.18.1 1.17.0 1.16.2 1.14.0 1.13.0 1.12.1 1.11.1 1.10.1 1.9.1 1.8.3 1.7.1 1.6.1 1.5.0 Reference documentation and code samples for the Compute V1 Client class InstanceGroupManagerUpdatePolicy.

Generated from protobuf message `google.cloud.compute.v1.InstanceGroupManagerUpdatePolicy`

## Namespace

Google \\ Cloud \\ Compute \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ instance_redistribution_type` | `string` 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. |
| `↳ max_surge` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.FixedOrPercent` The maximum number of instances that can be created above the specifiedtargetSize 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 ormaxUnavailable must be greater than 0. Learn more about maxSurge. |
| `↳ max_unavailable` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.FixedOrPercent` 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 formaxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable. |
| `↳ minimal_action` | `string` 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 toREFRESH. 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. |
| `↳ most_disruptive_allowed_action` | `string` 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. |
| `↳ replacement_method` | `string` What action should be used to replace instances. See minimal_action.REPLACE Check the ReplacementMethod enum for the list of possible values. |
| `↳ type` | `string` The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want to update. Check the Type enum for the list of possible values. |

### 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasInstanceRedistributionType

### clearInstanceRedistributionType

### setInstanceRedistributionType

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getMaxSurge

The maximum number of instances that can be created above the specifiedtargetSize 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 ormaxUnavailable must be greater than 0. Learn more about maxSurge.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.FixedOrPercent|null` |   |

### hasMaxSurge

### clearMaxSurge

### setMaxSurge

The maximum number of instances that can be created above the specifiedtargetSize 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 ormaxUnavailable must be greater than 0. Learn more about maxSurge.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.FixedOrPercent` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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 formaxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.FixedOrPercent|null` |   |

### hasMaxUnavailable

### clearMaxUnavailable

### setMaxUnavailable

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 formaxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-compute/latest/V1.FixedOrPercent` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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 toREFRESH. 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasMinimalAction

### clearMinimalAction

### setMinimalAction

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 toREFRESH. 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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasMostDisruptiveAllowedAction

### clearMostDisruptiveAllowedAction

### setMostDisruptiveAllowedAction

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getReplacementMethod

What action should be used to replace instances.

See minimal_action.REPLACE
Check the ReplacementMethod enum for the list of possible values.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasReplacementMethod

### clearReplacementMethod

### setReplacementMethod

What action should be used to replace instances.

See minimal_action.REPLACE
Check the ReplacementMethod enum for the list of possible values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getType

The type
of update process. You can specify either PROACTIVE so
that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
to update.

Check the Type enum for the list of possible values.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasType

### clearType

### setType

The type
of update process. You can specify either PROACTIVE so
that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
to update.

Check the Type enum for the list of possible values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |