InstanceGroupManagerUpdatePolicy (Compute Engine API alpha (Rev. 106) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.InstanceGroupManagerUpdatePolicy

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class InstanceGroupManagerUpdatePolicy
extends com.google.api.client.json.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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

InstanceGroupManagerUpdatePolicy()

Constructors
Constructor and Description
`InstanceGroupManagerUpdatePolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstanceGroupManagerUpdatePolicy`	`clone()`
`java.lang.String`	`getInstanceRedistributionType()`
`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.
`java.lang.String`	`getMinimalAction()` Minimal action to be taken on an instance.
`java.lang.Integer`	`getMinReadySec()` Minimum number of seconds to wait for after a newly created instance becomes available.
`java.lang.String`	`getReplacementMethod()` What action should be used to replace instances.
`java.lang.String`	`getType()`
`InstanceGroupManagerUpdatePolicy`	`set(java.lang.String fieldName, java.lang.Object value)`
`InstanceGroupManagerUpdatePolicy`	`setInstanceRedistributionType(java.lang.String instanceRedistributionType)`
`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(java.lang.String minimalAction)` Minimal action to be taken on an instance.
`InstanceGroupManagerUpdatePolicy`	`setMinReadySec(java.lang.Integer minReadySec)` Minimum number of seconds to wait for after a newly created instance becomes available.
`InstanceGroupManagerUpdatePolicy`	`setReplacementMethod(java.lang.String replacementMethod)` What action should be used to replace instances.
`InstanceGroupManagerUpdatePolicy`	`setType(java.lang.String type)`

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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 java.lang.String getInstanceRedistributionType()
```
    Returns:
    
    value or null for none
  - setInstanceRedistributionType
```
public InstanceGroupManagerUpdatePolicy setInstanceRedistributionType(java.lang.String instanceRedistributionType)
```
    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
  - getMinReadySec
```
public java.lang.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(java.lang.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 java.lang.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(java.lang.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
  - getReplacementMethod
```
public java.lang.String getReplacementMethod()
```
    What action should be used to replace instances. See minimal_action.REPLACE
    
    Returns:
    
    value or null for none
  - setReplacementMethod
```
public InstanceGroupManagerUpdatePolicy setReplacementMethod(java.lang.String replacementMethod)
```
    What action should be used to replace instances. See minimal_action.REPLACE
    
    Parameters:
    
    replacementMethod - replacementMethod or null for none
  - getType
```
public java.lang.String getType()
```
    Returns:
    
    value or null for none
  - setType
```
public InstanceGroupManagerUpdatePolicy setType(java.lang.String type)
```
    Parameters:
    
    type - type or null for none
  - set
```
public InstanceGroupManagerUpdatePolicy set(java.lang.String fieldName,
                                            java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public InstanceGroupManagerUpdatePolicy clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API alpha (revision 106)

Class InstanceGroupManagerUpdatePolicy

Nested Class Summary

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

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

InstanceGroupManagerUpdatePolicy

Method Detail

getInstanceRedistributionType

setInstanceRedistributionType

getMaxSurge

setMaxSurge

getMaxUnavailable

setMaxUnavailable

getMinReadySec

setMinReadySec

getMinimalAction

setMinimalAction

getReplacementMethod

setReplacementMethod

getType

setType

set

clone