com.google.api.services.container.model

Class NodePool

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.container.model.NodePool

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class NodePool
extends GenericJson

NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

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

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
NodePool()

Method Summary

Modifier and Type	Method and Description
NodePool	clone()
NodePoolAutoscaling	getAutoscaling() Autoscaler configuration for this NodePool.
List<StatusCondition>	getConditions() Which conditions caused the current node pool state.
NodeConfig	getConfig() The node configuration of the pool.
Integer	getInitialNodeCount() The initial node count for the pool.
List<String>	getInstanceGroupUrls() [Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups /creating-groups-of-managed-instances) associated with this node pool.
List<String>	getLocations() The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the NodePool's nodes should be located.
NodeManagement	getManagement() NodeManagement configuration for this NodePool.
MaxPodsConstraint	getMaxPodsConstraint() The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
String	getName() The name of the node pool.
Integer	getPodIpv4CidrSize() [Output only] The pod CIDR block size per node in this node pool.
String	getSelfLink() [Output only] Server-defined URL for the resource.
String	getStatus() [Output only] The status of the nodes in this pool instance.
String	getStatusMessage() [Output only] Additional information about the current status of this node pool instance, if available.
UpgradeSettings	getUpgradeSettings() Upgrade settings control disruption and speed of the upgrade.
String	getVersion() The version of the Kubernetes of this node.
NodePool	set(String fieldName, Object value)
NodePool	setAutoscaling(NodePoolAutoscaling autoscaling) Autoscaler configuration for this NodePool.
NodePool	setConditions(List<StatusCondition> conditions) Which conditions caused the current node pool state.
NodePool	setConfig(NodeConfig config) The node configuration of the pool.
NodePool	setInitialNodeCount(Integer initialNodeCount) The initial node count for the pool.
NodePool	setInstanceGroupUrls(List<String> instanceGroupUrls) [Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups /creating-groups-of-managed-instances) associated with this node pool.
NodePool	setLocations(List<String> locations) The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the NodePool's nodes should be located.
NodePool	setManagement(NodeManagement management) NodeManagement configuration for this NodePool.
NodePool	setMaxPodsConstraint(MaxPodsConstraint maxPodsConstraint) The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
NodePool	setName(String name) The name of the node pool.
NodePool	setPodIpv4CidrSize(Integer podIpv4CidrSize) [Output only] The pod CIDR block size per node in this node pool.
NodePool	setSelfLink(String selfLink) [Output only] Server-defined URL for the resource.
NodePool	setStatus(String status) [Output only] The status of the nodes in this pool instance.
NodePool	setStatusMessage(String statusMessage) [Output only] Additional information about the current status of this node pool instance, if available.
NodePool	setUpgradeSettings(UpgradeSettings upgradeSettings) Upgrade settings control disruption and speed of the upgrade.
NodePool	setVersion(String version) The version of the Kubernetes of this node.

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

NodePool

public NodePool()

Method Detail

getAutoscaling

public NodePoolAutoscaling getAutoscaling()

Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

Returns:

value or null for none

setAutoscaling

public NodePool setAutoscaling(NodePoolAutoscaling autoscaling)

Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

Parameters:

autoscaling - autoscaling or null for none

getConditions

public List<StatusCondition> getConditions()

Which conditions caused the current node pool state.

Returns:

value or null for none

setConditions

public NodePool setConditions(List<StatusCondition> conditions)

Which conditions caused the current node pool state.

Parameters:

conditions - conditions or null for none

getConfig

public NodeConfig getConfig()

The node configuration of the pool.

Returns:

value or null for none

setConfig

public NodePool setConfig(NodeConfig config)

The node configuration of the pool.

Parameters:

config - config or null for none

getInitialNodeCount

public Integer getInitialNodeCount()

The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

Returns:

value or null for none

setInitialNodeCount

public NodePool setInitialNodeCount(Integer initialNodeCount)

The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

Parameters:

initialNodeCount - initialNodeCount or null for none

getInstanceGroupUrls

public List<String> getInstanceGroupUrls()

[Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups /creating-groups-of-managed-instances) associated with this node pool.

Returns:

value or null for none

setInstanceGroupUrls

public NodePool setInstanceGroupUrls(List<String> instanceGroupUrls)

[Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups /creating-groups-of-managed-instances) associated with this node pool.

Parameters:

instanceGroupUrls - instanceGroupUrls or null for none

getLocations

public List<String> getLocations()

The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the NodePool's nodes should be located.

Returns:

value or null for none

setLocations

public NodePool setLocations(List<String> locations)

The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the NodePool's nodes should be located.

Parameters:

locations - locations or null for none

getManagement

public NodeManagement getManagement()

NodeManagement configuration for this NodePool.

Returns:

value or null for none

setManagement

public NodePool setManagement(NodeManagement management)

NodeManagement configuration for this NodePool.

Parameters:

management - management or null for none

getMaxPodsConstraint

public MaxPodsConstraint getMaxPodsConstraint()

The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

Returns:

value or null for none

setMaxPodsConstraint

public NodePool setMaxPodsConstraint(MaxPodsConstraint maxPodsConstraint)

The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

Parameters:

maxPodsConstraint - maxPodsConstraint or null for none

getName

public String getName()

The name of the node pool.

Returns:

value or null for none

setName

public NodePool setName(String name)

The name of the node pool.

Parameters:

name - name or null for none

getPodIpv4CidrSize

public Integer getPodIpv4CidrSize()

[Output only] The pod CIDR block size per node in this node pool.

Returns:

value or null for none

setPodIpv4CidrSize

public NodePool setPodIpv4CidrSize(Integer podIpv4CidrSize)

[Output only] The pod CIDR block size per node in this node pool.

Parameters:

podIpv4CidrSize - podIpv4CidrSize or null for none

getSelfLink

public String getSelfLink()

[Output only] Server-defined URL for the resource.

Returns:

value or null for none

setSelfLink

public NodePool setSelfLink(String selfLink)

[Output only] Server-defined URL for the resource.

Parameters:

selfLink - selfLink or null for none

getStatus

public String getStatus()

[Output only] The status of the nodes in this pool instance.

Returns:

value or null for none

setStatus

public NodePool setStatus(String status)

[Output only] The status of the nodes in this pool instance.

Parameters:

status - status or null for none

getStatusMessage

public String getStatusMessage()

[Output only] Additional information about the current status of this node pool instance, if available.

Returns:

value or null for none

setStatusMessage

public NodePool setStatusMessage(String statusMessage)

[Output only] Additional information about the current status of this node pool instance, if available.

Parameters:

statusMessage - statusMessage or null for none

getUpgradeSettings

public UpgradeSettings getUpgradeSettings()

Upgrade settings control disruption and speed of the upgrade.

Returns:

value or null for none

setUpgradeSettings

public NodePool setUpgradeSettings(UpgradeSettings upgradeSettings)

Upgrade settings control disruption and speed of the upgrade.

Parameters:

upgradeSettings - upgradeSettings or null for none

getVersion

public String getVersion()

The version of the Kubernetes of this node.

Returns:

value or null for none

setVersion

public NodePool setVersion(String version)

The version of the Kubernetes of this node.

Parameters:

version - version or null for none

set

public NodePool set(String fieldName,
                    Object value)

Overrides:

set in class GenericJson

clone

public NodePool clone()

Overrides:

clone in class GenericJson