com.google.api.services.container.model

Class UpgradeSettings

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.container.model.UpgradeSettings

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class UpgradeSettings
extends com.google.api.client.json.GenericJson

These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available.

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 Kubernetes 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
UpgradeSettings()

Method Summary

Modifier and Type	Method and Description
UpgradeSettings	clone()
java.lang.Integer	getMaxSurge() The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
java.lang.Integer	getMaxUnavailable() The maximum number of nodes that can be simultaneously unavailable during the upgrade process.
UpgradeSettings	set(java.lang.String fieldName, java.lang.Object value)
UpgradeSettings	setMaxSurge(java.lang.Integer maxSurge) The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
UpgradeSettings	setMaxUnavailable(java.lang.Integer maxUnavailable) The maximum number of nodes that can be simultaneously unavailable during the upgrade 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, 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

UpgradeSettings

public UpgradeSettings()

Method Detail

getMaxSurge

public java.lang.Integer getMaxSurge()

The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

Returns:

value or null for none

setMaxSurge

public UpgradeSettings setMaxSurge(java.lang.Integer maxSurge)

The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

Parameters:

maxSurge - maxSurge or null for none

getMaxUnavailable

public java.lang.Integer getMaxUnavailable()

The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

Returns:

value or null for none

setMaxUnavailable

public UpgradeSettings setMaxUnavailable(java.lang.Integer maxUnavailable)

The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

Parameters:

maxUnavailable - maxUnavailable or null for none

set

public UpgradeSettings set(java.lang.String fieldName,
                           java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public UpgradeSettings clone()

Overrides:

clone in class com.google.api.client.json.GenericJson