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

Go to download







InstanceGroupManagerUpdatePolicy (Compute Engine API v1-rev20200104-1.30.8)











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.



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

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

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

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

Parameters:
maxUnavailable - maxUnavailable 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








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–2020 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.
`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`	`setType(String type)` The type of update process.