com.google.cloud.compute.v1

Class InstanceGroupManagerUpdatePolicy.Builder

java.lang.Object

com.google.cloud.compute.v1.InstanceGroupManagerUpdatePolicy.Builder

Enclosing class:

InstanceGroupManagerUpdatePolicy

public static class InstanceGroupManagerUpdatePolicy.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
InstanceGroupManagerUpdatePolicy	build()
InstanceGroupManagerUpdatePolicy.Builder	clone()
FixedOrPercent	getMaxSurge() The maximum number of instances that can be created above the specified targetSize during the update process.
FixedOrPercent	getMaxUnavailable() The maximum number of instances that can be unavailable during the update process.
String	getMinimalAction() Minimal action to be taken on an instance.
String	getType() The type of update process.
InstanceGroupManagerUpdatePolicy.Builder	mergeFrom(InstanceGroupManagerUpdatePolicy other)
InstanceGroupManagerUpdatePolicy.Builder	setMaxSurge(FixedOrPercent maxSurge) The maximum number of instances that can be created above the specified targetSize during the update process.
InstanceGroupManagerUpdatePolicy.Builder	setMaxUnavailable(FixedOrPercent maxUnavailable) The maximum number of instances that can be unavailable during the update process.
InstanceGroupManagerUpdatePolicy.Builder	setMinimalAction(String minimalAction) Minimal action to be taken on an instance.
InstanceGroupManagerUpdatePolicy.Builder	setType(String type) The type of update process.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

mergeFrom

public InstanceGroupManagerUpdatePolicy.Builder mergeFrom(InstanceGroupManagerUpdatePolicy other)

getMaxSurge

public FixedOrPercent getMaxSurge()

The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

setMaxSurge

public InstanceGroupManagerUpdatePolicy.Builder setMaxSurge(FixedOrPercent maxSurge)

The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.

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 liveness health check result 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. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

setMaxUnavailable

public InstanceGroupManagerUpdatePolicy.Builder setMaxUnavailable(FixedOrPercent 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 liveness health check result 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. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.

At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.

getMinimalAction

public String getMinimalAction()

Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

setMinimalAction

public InstanceGroupManagerUpdatePolicy.Builder setMinimalAction(String minimalAction)

Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

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

setType

public InstanceGroupManagerUpdatePolicy.Builder setType(String type)

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

build

public InstanceGroupManagerUpdatePolicy build()

clone

public InstanceGroupManagerUpdatePolicy.Builder clone()

Overrides:

clone in class Object