public final class NodePool extends GeneratedMessageV3 implements NodePoolOrBuilderNodePool 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. 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.
Protobuf type google.container.v1beta1.NodePool
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NodePoolImplements
NodePoolOrBuilderStatic Fields
AUTOSCALING_FIELD_NUMBER
public static final int AUTOSCALING_FIELD_NUMBER| Type | Description |
| int |
CONDITIONS_FIELD_NUMBER
public static final int CONDITIONS_FIELD_NUMBER| Type | Description |
| int |
CONFIG_FIELD_NUMBER
public static final int CONFIG_FIELD_NUMBER| Type | Description |
| int |
INITIAL_NODE_COUNT_FIELD_NUMBER
public static final int INITIAL_NODE_COUNT_FIELD_NUMBER| Type | Description |
| int |
INSTANCE_GROUP_URLS_FIELD_NUMBER
public static final int INSTANCE_GROUP_URLS_FIELD_NUMBER| Type | Description |
| int |
LOCATIONS_FIELD_NUMBER
public static final int LOCATIONS_FIELD_NUMBER| Type | Description |
| int |
MANAGEMENT_FIELD_NUMBER
public static final int MANAGEMENT_FIELD_NUMBER| Type | Description |
| int |
MAX_PODS_CONSTRAINT_FIELD_NUMBER
public static final int MAX_PODS_CONSTRAINT_FIELD_NUMBER| Type | Description |
| int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Type | Description |
| int |
NETWORK_CONFIG_FIELD_NUMBER
public static final int NETWORK_CONFIG_FIELD_NUMBER| Type | Description |
| int |
PLACEMENT_POLICY_FIELD_NUMBER
public static final int PLACEMENT_POLICY_FIELD_NUMBER| Type | Description |
| int |
POD_IPV4_CIDR_SIZE_FIELD_NUMBER
public static final int POD_IPV4_CIDR_SIZE_FIELD_NUMBER| Type | Description |
| int |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER| Type | Description |
| int |
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER| Type | Description |
| int |
STATUS_MESSAGE_FIELD_NUMBER
public static final int STATUS_MESSAGE_FIELD_NUMBER| Type | Description |
| int |
UPDATE_INFO_FIELD_NUMBER
public static final int UPDATE_INFO_FIELD_NUMBER| Type | Description |
| int |
UPGRADE_SETTINGS_FIELD_NUMBER
public static final int UPGRADE_SETTINGS_FIELD_NUMBER| Type | Description |
| int |
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static NodePool getDefaultInstance()| Type | Description |
| NodePool |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static NodePool.Builder newBuilder()| Type | Description |
| NodePool.Builder |
newBuilder(NodePool prototype)
public static NodePool.Builder newBuilder(NodePool prototype)| Name | Description |
| prototype | NodePool |
| Type | Description |
| NodePool.Builder |
parseDelimitedFrom(InputStream input)
public static NodePool parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| NodePool |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NodePool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| NodePool |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static NodePool parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| NodePool |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NodePool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| NodePool |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static NodePool parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| NodePool |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NodePool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| NodePool |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static NodePool parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| NodePool |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NodePool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| NodePool |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static NodePool parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| NodePool |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NodePool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| NodePool |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static NodePool parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| NodePool |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NodePool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| NodePool |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<NodePool> parser()| Type | Description |
| Parser<NodePool> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getAutoscaling()
public NodePoolAutoscaling getAutoscaling()Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
.google.container.v1beta1.NodePoolAutoscaling autoscaling = 4;
| Type | Description |
| NodePoolAutoscaling | The autoscaling. |
getAutoscalingOrBuilder()
public NodePoolAutoscalingOrBuilder getAutoscalingOrBuilder()Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
.google.container.v1beta1.NodePoolAutoscaling autoscaling = 4;
| Type | Description |
| NodePoolAutoscalingOrBuilder |
getConditions(int index)
public StatusCondition getConditions(int index)Which conditions caused the current node pool state.
repeated .google.container.v1beta1.StatusCondition conditions = 105;
| Name | Description |
| index | int |
| Type | Description |
| StatusCondition |
getConditionsCount()
public int getConditionsCount()Which conditions caused the current node pool state.
repeated .google.container.v1beta1.StatusCondition conditions = 105;
| Type | Description |
| int |
getConditionsList()
public List<StatusCondition> getConditionsList()Which conditions caused the current node pool state.
repeated .google.container.v1beta1.StatusCondition conditions = 105;
| Type | Description |
| List<StatusCondition> |
getConditionsOrBuilder(int index)
public StatusConditionOrBuilder getConditionsOrBuilder(int index)Which conditions caused the current node pool state.
repeated .google.container.v1beta1.StatusCondition conditions = 105;
| Name | Description |
| index | int |
| Type | Description |
| StatusConditionOrBuilder |
getConditionsOrBuilderList()
public List<? extends StatusConditionOrBuilder> getConditionsOrBuilderList()Which conditions caused the current node pool state.
repeated .google.container.v1beta1.StatusCondition conditions = 105;
| Type | Description |
| List<? extends com.google.container.v1beta1.StatusConditionOrBuilder> |
getConfig()
public NodeConfig getConfig()The node configuration of the pool.
.google.container.v1beta1.NodeConfig config = 2;
| Type | Description |
| NodeConfig | The config. |
getConfigOrBuilder()
public NodeConfigOrBuilder getConfigOrBuilder()The node configuration of the pool.
.google.container.v1beta1.NodeConfig config = 2;
| Type | Description |
| NodeConfigOrBuilder |
getDefaultInstanceForType()
public NodePool getDefaultInstanceForType()| Type | Description |
| NodePool |
getInitialNodeCount()
public int 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.
int32 initial_node_count = 3;
| Type | Description |
| int | The initialNodeCount. |
getInstanceGroupUrls(int index)
public String getInstanceGroupUrls(int index)[Output only] The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
repeated string instance_group_urls = 102;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The instanceGroupUrls at the given index. |
getInstanceGroupUrlsBytes(int index)
public ByteString getInstanceGroupUrlsBytes(int index)[Output only] The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
repeated string instance_group_urls = 102;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the instanceGroupUrls at the given index. |
getInstanceGroupUrlsCount()
public int getInstanceGroupUrlsCount()[Output only] The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
repeated string instance_group_urls = 102;
| Type | Description |
| int | The count of instanceGroupUrls. |
getInstanceGroupUrlsList()
public ProtocolStringList getInstanceGroupUrlsList()[Output only] The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
repeated string instance_group_urls = 102;
| Type | Description |
| ProtocolStringList | A list containing the instanceGroupUrls. |
getLocations(int index)
public String getLocations(int index)The list of Google Compute Engine zones in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
repeated string locations = 13;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The locations at the given index. |
getLocationsBytes(int index)
public ByteString getLocationsBytes(int index)The list of Google Compute Engine zones in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
repeated string locations = 13;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the locations at the given index. |
getLocationsCount()
public int getLocationsCount()The list of Google Compute Engine zones in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
repeated string locations = 13;
| Type | Description |
| int | The count of locations. |
getLocationsList()
public ProtocolStringList getLocationsList()The list of Google Compute Engine zones in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
repeated string locations = 13;
| Type | Description |
| ProtocolStringList | A list containing the locations. |
getManagement()
public NodeManagement getManagement()NodeManagement configuration for this NodePool.
.google.container.v1beta1.NodeManagement management = 5;
| Type | Description |
| NodeManagement | The management. |
getManagementOrBuilder()
public NodeManagementOrBuilder getManagementOrBuilder()NodeManagement configuration for this NodePool.
.google.container.v1beta1.NodeManagement management = 5;
| Type | Description |
| NodeManagementOrBuilder |
getMaxPodsConstraint()
public MaxPodsConstraint getMaxPodsConstraint()The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
.google.container.v1beta1.MaxPodsConstraint max_pods_constraint = 6;
| Type | Description |
| MaxPodsConstraint | The maxPodsConstraint. |
getMaxPodsConstraintOrBuilder()
public MaxPodsConstraintOrBuilder getMaxPodsConstraintOrBuilder()The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
.google.container.v1beta1.MaxPodsConstraint max_pods_constraint = 6;
| Type | Description |
| MaxPodsConstraintOrBuilder |
getName()
public String getName()The name of the node pool.
string name = 1;
| Type | Description |
| String | The name. |
getNameBytes()
public ByteString getNameBytes()The name of the node pool.
string name = 1;
| Type | Description |
| ByteString | The bytes for name. |
getNetworkConfig()
public NodeNetworkConfig getNetworkConfig()Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
.google.container.v1beta1.NodeNetworkConfig network_config = 14;
| Type | Description |
| NodeNetworkConfig | The networkConfig. |
getNetworkConfigOrBuilder()
public NodeNetworkConfigOrBuilder getNetworkConfigOrBuilder()Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
.google.container.v1beta1.NodeNetworkConfig network_config = 14;
| Type | Description |
| NodeNetworkConfigOrBuilder |
getParserForType()
public Parser<NodePool> getParserForType()| Type | Description |
| Parser<NodePool> |
getPlacementPolicy()
public NodePool.PlacementPolicy getPlacementPolicy()Specifies the node placement policy.
.google.container.v1beta1.NodePool.PlacementPolicy placement_policy = 108;
| Type | Description |
| NodePool.PlacementPolicy | The placementPolicy. |
getPlacementPolicyOrBuilder()
public NodePool.PlacementPolicyOrBuilder getPlacementPolicyOrBuilder()Specifies the node placement policy.
.google.container.v1beta1.NodePool.PlacementPolicy placement_policy = 108;
| Type | Description |
| NodePool.PlacementPolicyOrBuilder |
getPodIpv4CidrSize()
public int getPodIpv4CidrSize()[Output only] The pod CIDR block size per node in this node pool.
int32 pod_ipv4_cidr_size = 7;
| Type | Description |
| int | The podIpv4CidrSize. |
getSelfLink()
public String getSelfLink()[Output only] Server-defined URL for the resource.
string self_link = 100;
| Type | Description |
| String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()[Output only] Server-defined URL for the resource.
string self_link = 100;
| Type | Description |
| ByteString | The bytes for selfLink. |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getStatus()
public NodePool.Status getStatus()[Output only] The status of the nodes in this pool instance.
.google.container.v1beta1.NodePool.Status status = 103;
| Type | Description |
| NodePool.Status | The status. |
getStatusMessage() (deprecated)
public String getStatusMessage()Deprecated. google.container.v1beta1.NodePool.status_message is deprecated. See google/container/v1beta1/cluster_service.proto;l=3451
[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
string status_message = 104 [deprecated = true];
| Type | Description |
| String | The statusMessage. |
getStatusMessageBytes() (deprecated)
public ByteString getStatusMessageBytes()Deprecated. google.container.v1beta1.NodePool.status_message is deprecated. See google/container/v1beta1/cluster_service.proto;l=3451
[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
string status_message = 104 [deprecated = true];
| Type | Description |
| ByteString | The bytes for statusMessage. |
getStatusValue()
public int getStatusValue()[Output only] The status of the nodes in this pool instance.
.google.container.v1beta1.NodePool.Status status = 103;
| Type | Description |
| int | The enum numeric value on the wire for status. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
getUpdateInfo()
public NodePool.UpdateInfo getUpdateInfo()Output only. [Output only] Update info contains relevant information during a node pool update.
.google.container.v1beta1.NodePool.UpdateInfo update_info = 109 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| NodePool.UpdateInfo | The updateInfo. |
getUpdateInfoOrBuilder()
public NodePool.UpdateInfoOrBuilder getUpdateInfoOrBuilder()Output only. [Output only] Update info contains relevant information during a node pool update.
.google.container.v1beta1.NodePool.UpdateInfo update_info = 109 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| NodePool.UpdateInfoOrBuilder |
getUpgradeSettings()
public NodePool.UpgradeSettings getUpgradeSettings()Upgrade settings control disruption and speed of the upgrade.
.google.container.v1beta1.NodePool.UpgradeSettings upgrade_settings = 107;
| Type | Description |
| NodePool.UpgradeSettings | The upgradeSettings. |
getUpgradeSettingsOrBuilder()
public NodePool.UpgradeSettingsOrBuilder getUpgradeSettingsOrBuilder()Upgrade settings control disruption and speed of the upgrade.
.google.container.v1beta1.NodePool.UpgradeSettings upgrade_settings = 107;
| Type | Description |
| NodePool.UpgradeSettingsOrBuilder |
getVersion()
public String getVersion()The version of the Kubernetes of this node.
string version = 101;
| Type | Description |
| String | The version. |
getVersionBytes()
public ByteString getVersionBytes()The version of the Kubernetes of this node.
string version = 101;
| Type | Description |
| ByteString | The bytes for version. |
hasAutoscaling()
public boolean hasAutoscaling()Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
.google.container.v1beta1.NodePoolAutoscaling autoscaling = 4;
| Type | Description |
| boolean | Whether the autoscaling field is set. |
hasConfig()
public boolean hasConfig()The node configuration of the pool.
.google.container.v1beta1.NodeConfig config = 2;
| Type | Description |
| boolean | Whether the config field is set. |
hasManagement()
public boolean hasManagement()NodeManagement configuration for this NodePool.
.google.container.v1beta1.NodeManagement management = 5;
| Type | Description |
| boolean | Whether the management field is set. |
hasMaxPodsConstraint()
public boolean hasMaxPodsConstraint()The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
.google.container.v1beta1.MaxPodsConstraint max_pods_constraint = 6;
| Type | Description |
| boolean | Whether the maxPodsConstraint field is set. |
hasNetworkConfig()
public boolean hasNetworkConfig()Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
.google.container.v1beta1.NodeNetworkConfig network_config = 14;
| Type | Description |
| boolean | Whether the networkConfig field is set. |
hasPlacementPolicy()
public boolean hasPlacementPolicy()Specifies the node placement policy.
.google.container.v1beta1.NodePool.PlacementPolicy placement_policy = 108;
| Type | Description |
| boolean | Whether the placementPolicy field is set. |
hasUpdateInfo()
public boolean hasUpdateInfo()Output only. [Output only] Update info contains relevant information during a node pool update.
.google.container.v1beta1.NodePool.UpdateInfo update_info = 109 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateInfo field is set. |
hasUpgradeSettings()
public boolean hasUpgradeSettings()Upgrade settings control disruption and speed of the upgrade.
.google.container.v1beta1.NodePool.UpgradeSettings upgrade_settings = 107;
| Type | Description |
| boolean | Whether the upgradeSettings field is set. |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public NodePool.Builder newBuilderForType()| Type | Description |
| NodePool.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NodePool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| NodePool.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public NodePool.Builder toBuilder()| Type | Description |
| NodePool.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |