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 com.google.api.client.json.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

com.google.api.client.util.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.
BestEffortProvisioning	getBestEffortProvisioning() Enable best effort provisioning for nodes
List<StatusCondition>	getConditions() Which conditions caused the current node pool state.
NodeConfig	getConfig() The node configuration of the pool.
String	getEtag() This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
Integer	getInitialNodeCount() The initial node count for the pool.
List<String>	getInstanceGroupUrls() [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed- instances) associated with this node pool.
List<String>	getLocations() The list of Google Compute Engine [zones](https://cloud.google.com/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.
NodeNetworkConfig	getNetworkConfig() Networking configuration for this NodePool.
PlacementPolicy	getPlacementPolicy() Specifies the node placement policy.
Integer	getPodIpv4CidrSize() [Output only] The pod CIDR block size per node in this node pool.
QueuedProvisioning	getQueuedProvisioning() Specifies the configuration of queued provisioning.
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] Deprecated.
UpdateInfo	getUpdateInfo() Output only.
UpgradeSettings	getUpgradeSettings() Upgrade settings control disruption and speed of the upgrade.
String	getVersion() The version of Kubernetes running on this NodePool's nodes.
NodePool	set(String fieldName, Object value)
NodePool	setAutoscaling(NodePoolAutoscaling autoscaling) Autoscaler configuration for this NodePool.
NodePool	setBestEffortProvisioning(BestEffortProvisioning bestEffortProvisioning) Enable best effort provisioning for nodes
NodePool	setConditions(List<StatusCondition> conditions) Which conditions caused the current node pool state.
NodePool	setConfig(NodeConfig config) The node configuration of the pool.
NodePool	setEtag(String etag) This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
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](https://cloud.google.com/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](https://cloud.google.com/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	setNetworkConfig(NodeNetworkConfig networkConfig) Networking configuration for this NodePool.
NodePool	setPlacementPolicy(PlacementPolicy placementPolicy) Specifies the node placement policy.
NodePool	setPodIpv4CidrSize(Integer podIpv4CidrSize) [Output only] The pod CIDR block size per node in this node pool.
NodePool	setQueuedProvisioning(QueuedProvisioning queuedProvisioning) Specifies the configuration of queued provisioning.
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] Deprecated.
NodePool	setUpdateInfo(UpdateInfo updateInfo) Output only.
NodePool	setUpgradeSettings(UpgradeSettings upgradeSettings) Upgrade settings control disruption and speed of the upgrade.
NodePool	setVersion(String version) The version of Kubernetes running on this NodePool's nodes.

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

getBestEffortProvisioning

public BestEffortProvisioning getBestEffortProvisioning()

Enable best effort provisioning for nodes

Returns:

value or null for none

setBestEffortProvisioning

public NodePool setBestEffortProvisioning(BestEffortProvisioning bestEffortProvisioning)

Enable best effort provisioning for nodes

Parameters:

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

getEtag

public String getEtag()

This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

Returns:

value or null for none

setEtag

public NodePool setEtag(String etag)

This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

Parameters:

etag - etag or null for none

getInitialNodeCount

public Integer getInitialNodeCount()

The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) 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](https://cloud.google.com/compute/quotas) 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](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed- instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.

Returns:

value or null for none

setInstanceGroupUrls

public NodePool setInstanceGroupUrls(List<String> instanceGroupUrls)

[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed- instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.

Parameters:

instanceGroupUrls - instanceGroupUrls or null for none

getLocations

public List<String> getLocations()

The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes- engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.

Returns:

value or null for none

setLocations

public NodePool setLocations(List<String> locations)

The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes- engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.

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

getNetworkConfig

public NodeNetworkConfig getNetworkConfig()

Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.

Returns:

value or null for none

setNetworkConfig

public NodePool setNetworkConfig(NodeNetworkConfig networkConfig)

Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.

Parameters:

networkConfig - networkConfig or null for none

getPlacementPolicy

public PlacementPolicy getPlacementPolicy()

Specifies the node placement policy.

Returns:

value or null for none

setPlacementPolicy

public NodePool setPlacementPolicy(PlacementPolicy placementPolicy)

Specifies the node placement policy.

Parameters:

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

getQueuedProvisioning

public QueuedProvisioning getQueuedProvisioning()

Specifies the configuration of queued provisioning.

Returns:

value or null for none

setQueuedProvisioning

public NodePool setQueuedProvisioning(QueuedProvisioning queuedProvisioning)

Specifies the configuration of queued provisioning.

Parameters:

queuedProvisioning - queuedProvisioning 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] Deprecated. Use conditions instead. 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] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.

Parameters:

statusMessage - statusMessage or null for none

getUpdateInfo

public UpdateInfo getUpdateInfo()

Output only. [Output only] Update info contains relevant information during a node pool update.

Returns:

value or null for none

setUpdateInfo

public NodePool setUpdateInfo(UpdateInfo updateInfo)

Output only. [Output only] Update info contains relevant information during a node pool update.

Parameters:

updateInfo - updateInfo 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 Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes- engine/versioning#specifying_node_version).

Returns:

value or null for none

setVersion

public NodePool setVersion(String version)

The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes- engine/versioning#specifying_node_version).

Parameters:

version - version or null for none

set

public NodePool set(String fieldName,
                    Object value)

Overrides:

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

clone

public NodePool clone()

Overrides:

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