Interface NodePoolOrBuilder (2.56.0) 

public interface NodePoolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutoscaling()

public abstract NodePoolAutoscaling getAutoscaling()

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

.google.container.v1.NodePoolAutoscaling autoscaling = 4;

Returns
Type Description
NodePoolAutoscaling

The autoscaling.

getAutoscalingOrBuilder()

public abstract NodePoolAutoscalingOrBuilder getAutoscalingOrBuilder()

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

.google.container.v1.NodePoolAutoscaling autoscaling = 4;

Returns
Type Description
NodePoolAutoscalingOrBuilder

getBestEffortProvisioning()

public abstract BestEffortProvisioning getBestEffortProvisioning()

Enable best effort provisioning for nodes

.google.container.v1.BestEffortProvisioning best_effort_provisioning = 113;

Returns
Type Description
BestEffortProvisioning

The bestEffortProvisioning.

getBestEffortProvisioningOrBuilder()

public abstract BestEffortProvisioningOrBuilder getBestEffortProvisioningOrBuilder()

Enable best effort provisioning for nodes

.google.container.v1.BestEffortProvisioning best_effort_provisioning = 113;

Returns
Type Description
BestEffortProvisioningOrBuilder

getConditions(int index)

public abstract StatusCondition getConditions(int index)

Which conditions caused the current node pool state.

repeated .google.container.v1.StatusCondition conditions = 105;

Parameter
Name Description
index int
Returns
Type Description
StatusCondition

getConditionsCount()

public abstract int getConditionsCount()

Which conditions caused the current node pool state.

repeated .google.container.v1.StatusCondition conditions = 105;

Returns
Type Description
int

getConditionsList()

public abstract List<StatusCondition> getConditionsList()

Which conditions caused the current node pool state.

repeated .google.container.v1.StatusCondition conditions = 105;

Returns
Type Description
List<StatusCondition>

getConditionsOrBuilder(int index)

public abstract StatusConditionOrBuilder getConditionsOrBuilder(int index)

Which conditions caused the current node pool state.

repeated .google.container.v1.StatusCondition conditions = 105;

Parameter
Name Description
index int
Returns
Type Description
StatusConditionOrBuilder

getConditionsOrBuilderList()

public abstract List<? extends StatusConditionOrBuilder> getConditionsOrBuilderList()

Which conditions caused the current node pool state.

repeated .google.container.v1.StatusCondition conditions = 105;

Returns
Type Description
List<? extends com.google.container.v1.StatusConditionOrBuilder>

getConfig()

public abstract NodeConfig getConfig()

The node configuration of the pool.

.google.container.v1.NodeConfig config = 2;

Returns
Type Description
NodeConfig

The config.

getConfigOrBuilder()

public abstract NodeConfigOrBuilder getConfigOrBuilder()

The node configuration of the pool.

.google.container.v1.NodeConfig config = 2;

Returns
Type Description
NodeConfigOrBuilder

getEtag()

public abstract 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.

string etag = 110;

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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.

string etag = 110;

Returns
Type Description
ByteString

The bytes for etag.

getInitialNodeCount()

public abstract 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;

Returns
Type Description
int

The initialNodeCount.

getInstanceGroupUrls(int index)

public abstract 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The instanceGroupUrls at the given index.

getInstanceGroupUrlsBytes(int index)

public abstract 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the instanceGroupUrls at the given index.

getInstanceGroupUrlsCount()

public abstract 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of instanceGroupUrls.

getInstanceGroupUrlsList()

public abstract List<String> 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<String>

A list containing the instanceGroupUrls.

getLocations(int index)

public abstract 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;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The locations at the given index.

getLocationsBytes(int index)

public abstract 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;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the locations at the given index.

getLocationsCount()

public abstract 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;

Returns
Type Description
int

The count of locations.

getLocationsList()

public abstract List<String> 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;

Returns
Type Description
List<String>

A list containing the locations.

getManagement()

public abstract NodeManagement getManagement()

NodeManagement configuration for this NodePool.

.google.container.v1.NodeManagement management = 5;

Returns
Type Description
NodeManagement

The management.

getManagementOrBuilder()

public abstract NodeManagementOrBuilder getManagementOrBuilder()

NodeManagement configuration for this NodePool.

.google.container.v1.NodeManagement management = 5;

Returns
Type Description
NodeManagementOrBuilder

getMaxPodsConstraint()

public abstract MaxPodsConstraint getMaxPodsConstraint()

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

.google.container.v1.MaxPodsConstraint max_pods_constraint = 6;

Returns
Type Description
MaxPodsConstraint

The maxPodsConstraint.

getMaxPodsConstraintOrBuilder()

public abstract MaxPodsConstraintOrBuilder getMaxPodsConstraintOrBuilder()

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

.google.container.v1.MaxPodsConstraint max_pods_constraint = 6;

Returns
Type Description
MaxPodsConstraintOrBuilder

getName()

public abstract String getName()

The name of the node pool.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of the node pool.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNetworkConfig()

public abstract NodeNetworkConfig getNetworkConfig()

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

.google.container.v1.NodeNetworkConfig network_config = 14;

Returns
Type Description
NodeNetworkConfig

The networkConfig.

getNetworkConfigOrBuilder()

public abstract NodeNetworkConfigOrBuilder getNetworkConfigOrBuilder()

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

.google.container.v1.NodeNetworkConfig network_config = 14;

Returns
Type Description
NodeNetworkConfigOrBuilder

getPlacementPolicy()

public abstract NodePool.PlacementPolicy getPlacementPolicy()

Specifies the node placement policy.

.google.container.v1.NodePool.PlacementPolicy placement_policy = 108;

Returns
Type Description
NodePool.PlacementPolicy

The placementPolicy.

getPlacementPolicyOrBuilder()

public abstract NodePool.PlacementPolicyOrBuilder getPlacementPolicyOrBuilder()

Specifies the node placement policy.

.google.container.v1.NodePool.PlacementPolicy placement_policy = 108;

Returns
Type Description
NodePool.PlacementPolicyOrBuilder

getPodIpv4CidrSize()

public abstract int getPodIpv4CidrSize()

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

int32 pod_ipv4_cidr_size = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The podIpv4CidrSize.

getQueuedProvisioning()

public abstract NodePool.QueuedProvisioning getQueuedProvisioning()

Specifies the configuration of queued provisioning.

.google.container.v1.NodePool.QueuedProvisioning queued_provisioning = 112;

Returns
Type Description
NodePool.QueuedProvisioning

The queuedProvisioning.

getQueuedProvisioningOrBuilder()

public abstract NodePool.QueuedProvisioningOrBuilder getQueuedProvisioningOrBuilder()

Specifies the configuration of queued provisioning.

.google.container.v1.NodePool.QueuedProvisioning queued_provisioning = 112;

Returns
Type Description
NodePool.QueuedProvisioningOrBuilder

getSelfLink()

public abstract String getSelfLink()

Output only. Server-defined URL for the resource.

string self_link = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

Output only. Server-defined URL for the resource.

string self_link = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for selfLink.

getStatus()

public abstract NodePool.Status getStatus()

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

.google.container.v1.NodePool.Status status = 103 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
NodePool.Status

The status.

getStatusMessage() (deprecated)

public abstract String getStatusMessage()

Deprecated. google.container.v1.NodePool.status_message is deprecated. See google/container/v1/cluster_service.proto;l=3954

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, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The statusMessage.

getStatusMessageBytes() (deprecated)

public abstract ByteString getStatusMessageBytes()

Deprecated. google.container.v1.NodePool.status_message is deprecated. See google/container/v1/cluster_service.proto;l=3954

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, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for statusMessage.

getStatusValue()

public abstract int getStatusValue()

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

.google.container.v1.NodePool.Status status = 103 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getUpdateInfo()

public abstract NodePool.UpdateInfo getUpdateInfo()

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

.google.container.v1.NodePool.UpdateInfo update_info = 109 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
NodePool.UpdateInfo

The updateInfo.

getUpdateInfoOrBuilder()

public abstract NodePool.UpdateInfoOrBuilder getUpdateInfoOrBuilder()

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

.google.container.v1.NodePool.UpdateInfo update_info = 109 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
NodePool.UpdateInfoOrBuilder

getUpgradeSettings()

public abstract NodePool.UpgradeSettings getUpgradeSettings()

Upgrade settings control disruption and speed of the upgrade.

.google.container.v1.NodePool.UpgradeSettings upgrade_settings = 107;

Returns
Type Description
NodePool.UpgradeSettings

The upgradeSettings.

getUpgradeSettingsOrBuilder()

public abstract NodePool.UpgradeSettingsOrBuilder getUpgradeSettingsOrBuilder()

Upgrade settings control disruption and speed of the upgrade.

.google.container.v1.NodePool.UpgradeSettings upgrade_settings = 107;

Returns
Type Description
NodePool.UpgradeSettingsOrBuilder

getVersion()

public abstract String getVersion()

The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.

string version = 101;

Returns
Type Description
String

The version.

getVersionBytes()

public abstract ByteString getVersionBytes()

The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.

string version = 101;

Returns
Type Description
ByteString

The bytes for version.

hasAutoscaling()

public abstract boolean hasAutoscaling()

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

.google.container.v1.NodePoolAutoscaling autoscaling = 4;

Returns
Type Description
boolean

Whether the autoscaling field is set.

hasBestEffortProvisioning()

public abstract boolean hasBestEffortProvisioning()

Enable best effort provisioning for nodes

.google.container.v1.BestEffortProvisioning best_effort_provisioning = 113;

Returns
Type Description
boolean

Whether the bestEffortProvisioning field is set.

hasConfig()

public abstract boolean hasConfig()

The node configuration of the pool.

.google.container.v1.NodeConfig config = 2;

Returns
Type Description
boolean

Whether the config field is set.

hasManagement()

public abstract boolean hasManagement()

NodeManagement configuration for this NodePool.

.google.container.v1.NodeManagement management = 5;

Returns
Type Description
boolean

Whether the management field is set.

hasMaxPodsConstraint()

public abstract boolean hasMaxPodsConstraint()

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

.google.container.v1.MaxPodsConstraint max_pods_constraint = 6;

Returns
Type Description
boolean

Whether the maxPodsConstraint field is set.

hasNetworkConfig()

public abstract boolean hasNetworkConfig()

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

.google.container.v1.NodeNetworkConfig network_config = 14;

Returns
Type Description
boolean

Whether the networkConfig field is set.

hasPlacementPolicy()

public abstract boolean hasPlacementPolicy()

Specifies the node placement policy.

.google.container.v1.NodePool.PlacementPolicy placement_policy = 108;

Returns
Type Description
boolean

Whether the placementPolicy field is set.

hasQueuedProvisioning()

public abstract boolean hasQueuedProvisioning()

Specifies the configuration of queued provisioning.

.google.container.v1.NodePool.QueuedProvisioning queued_provisioning = 112;

Returns
Type Description
boolean

Whether the queuedProvisioning field is set.

hasUpdateInfo()

public abstract boolean hasUpdateInfo()

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

.google.container.v1.NodePool.UpdateInfo update_info = 109 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateInfo field is set.

hasUpgradeSettings()

public abstract boolean hasUpgradeSettings()

Upgrade settings control disruption and speed of the upgrade.

.google.container.v1.NodePool.UpgradeSettings upgrade_settings = 107;

Returns
Type Description
boolean

Whether the upgradeSettings field is set.