target.apidocs.com.google.api.services.compute.model.InstanceGroupManagerUpdatePolicy.html Maven / Gradle / Ivy

Go to download







InstanceGroupManagerUpdatePolicy (Compute Engine API beta-rev20220312-1.32.1)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class InstanceGroupManagerUpdatePolicy



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.InstanceGroupManagerUpdatePolicy













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class InstanceGroupManagerUpdatePolicy
extends GenericJson
Model definition for InstanceGroupManagerUpdatePolicy.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


InstanceGroupManagerUpdatePolicy() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


InstanceGroupManagerUpdatePolicy
clone() 


String
getInstanceRedistributionType()
The instance redistribution policy for regional managed instance groups.



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.



Integer
getMinReadySec()
Minimum number of seconds to wait for after a newly created instance becomes available.



String
getMostDisruptiveAllowedAction()
Most disruptive action that is allowed to be taken on an instance.



String
getReplacementMethod()
What action should be used to replace instances.



String
getType()
The type of update process.



InstanceGroupManagerUpdatePolicy
set(String fieldName,
   Object value) 


InstanceGroupManagerUpdatePolicy
setInstanceRedistributionType(String instanceRedistributionType)
The instance redistribution policy for regional managed instance groups.



InstanceGroupManagerUpdatePolicy
setMaxSurge(FixedOrPercent maxSurge)
The maximum number of instances that can be created above the specified targetSize during the
 update process.



InstanceGroupManagerUpdatePolicy
setMaxUnavailable(FixedOrPercent maxUnavailable)
The maximum number of instances that can be unavailable during the update process.



InstanceGroupManagerUpdatePolicy
setMinimalAction(String minimalAction)
Minimal action to be taken on an instance.



InstanceGroupManagerUpdatePolicy
setMinReadySec(Integer minReadySec)
Minimum number of seconds to wait for after a newly created instance becomes available.



InstanceGroupManagerUpdatePolicy
setMostDisruptiveAllowedAction(String mostDisruptiveAllowedAction)
Most disruptive action that is allowed to be taken on an instance.



InstanceGroupManagerUpdatePolicy
setReplacementMethod(String replacementMethod)
What action should be used to replace instances.



InstanceGroupManagerUpdatePolicy
setType(String type)
The type of update process.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





InstanceGroupManagerUpdatePolicy
public InstanceGroupManagerUpdatePolicy()









Method Detail





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.

Returns:
value or null for none








setInstanceRedistributionType
public InstanceGroupManagerUpdatePolicy setInstanceRedistributionType(String 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.

Parameters:
instanceRedistributionType - instanceRedistributionType or null for none








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.

Returns:
value or null for none








setMaxSurge
public InstanceGroupManagerUpdatePolicy setMaxSurge(FixedOrPercent 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.

Parameters:
maxSurge - maxSurge or null for none








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.

Returns:
value or null for none








setMaxUnavailable
public InstanceGroupManagerUpdatePolicy 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 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.

Parameters:
maxUnavailable - maxUnavailable or null for none








getMinReadySec
public Integer getMinReadySec()
Minimum number of seconds to wait for after a newly created instance becomes available. This
 value must be from range [0, 3600].

Returns:
value or null for none








setMinReadySec
public InstanceGroupManagerUpdatePolicy setMinReadySec(Integer minReadySec)
Minimum number of seconds to wait for after a newly created instance becomes available. This
 value must be from range [0, 3600].

Parameters:
minReadySec - minReadySec or null for none








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.

Returns:
value or null for none








setMinimalAction
public InstanceGroupManagerUpdatePolicy 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.

Parameters:
minimalAction - minimalAction or null for none








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.

Returns:
value or null for none








setMostDisruptiveAllowedAction
public InstanceGroupManagerUpdatePolicy setMostDisruptiveAllowedAction(String mostDisruptiveAllowedAction)
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.

Parameters:
mostDisruptiveAllowedAction - mostDisruptiveAllowedAction or null for none








getReplacementMethod
public String getReplacementMethod()
What action should be used to replace instances. See minimal_action.REPLACE

Returns:
value or null for none








setReplacementMethod
public InstanceGroupManagerUpdatePolicy setReplacementMethod(String replacementMethod)
What action should be used to replace instances. See minimal_action.REPLACE

Parameters:
replacementMethod - replacementMethod or null for none








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

Returns:
value or null for none








setType
public InstanceGroupManagerUpdatePolicy 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).

Parameters:
type - type or null for none








set
public InstanceGroupManagerUpdatePolicy set(String fieldName,
                                            Object value)

Overrides:
set in class GenericJson








clone
public InstanceGroupManagerUpdatePolicy clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.

Modifier and Type	Method and Description
`InstanceGroupManagerUpdatePolicy`	`clone()`
`String`	`getInstanceRedistributionType()` The instance redistribution policy for regional managed instance groups.
`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.
`Integer`	`getMinReadySec()` Minimum number of seconds to wait for after a newly created instance becomes available.
`String`	`getMostDisruptiveAllowedAction()` Most disruptive action that is allowed to be taken on an instance.
`String`	`getReplacementMethod()` What action should be used to replace instances.
`String`	`getType()` The type of update process.
`InstanceGroupManagerUpdatePolicy`	`set(String fieldName, Object value)`
`InstanceGroupManagerUpdatePolicy`	`setInstanceRedistributionType(String instanceRedistributionType)` The instance redistribution policy for regional managed instance groups.
`InstanceGroupManagerUpdatePolicy`	`setMaxSurge(FixedOrPercent maxSurge)` The maximum number of instances that can be created above the specified targetSize during the update process.
`InstanceGroupManagerUpdatePolicy`	`setMaxUnavailable(FixedOrPercent maxUnavailable)` The maximum number of instances that can be unavailable during the update process.
`InstanceGroupManagerUpdatePolicy`	`setMinimalAction(String minimalAction)` Minimal action to be taken on an instance.
`InstanceGroupManagerUpdatePolicy`	`setMinReadySec(Integer minReadySec)` Minimum number of seconds to wait for after a newly created instance becomes available.
`InstanceGroupManagerUpdatePolicy`	`setMostDisruptiveAllowedAction(String mostDisruptiveAllowedAction)` Most disruptive action that is allowed to be taken on an instance.
`InstanceGroupManagerUpdatePolicy`	`setReplacementMethod(String replacementMethod)` What action should be used to replace instances.
`InstanceGroupManagerUpdatePolicy`	`setType(String type)` The type of update process.