Class NodeNetworkConfig (2.46.0)

public final class NodeNetworkConfig extends GeneratedMessageV3 implements NodeNetworkConfigOrBuilder

Parameters for node pool-level network config.

Protobuf type google.container.v1.NodeNetworkConfig

Static Fields

ADDITIONAL_NODE_NETWORK_CONFIGS_FIELD_NUMBER

public static final int ADDITIONAL_NODE_NETWORK_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

ADDITIONAL_POD_NETWORK_CONFIGS_FIELD_NUMBER

public static final int ADDITIONAL_POD_NETWORK_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_POD_RANGE_FIELD_NUMBER

public static final int CREATE_POD_RANGE_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_PRIVATE_NODES_FIELD_NUMBER

public static final int ENABLE_PRIVATE_NODES_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_PERFORMANCE_CONFIG_FIELD_NUMBER

public static final int NETWORK_PERFORMANCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

POD_CIDR_OVERPROVISION_CONFIG_FIELD_NUMBER

public static final int POD_CIDR_OVERPROVISION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

POD_IPV4_CIDR_BLOCK_FIELD_NUMBER

public static final int POD_IPV4_CIDR_BLOCK_FIELD_NUMBER
Field Value
Type Description
int

POD_IPV4_RANGE_UTILIZATION_FIELD_NUMBER

public static final int POD_IPV4_RANGE_UTILIZATION_FIELD_NUMBER
Field Value
Type Description
int

POD_RANGE_FIELD_NUMBER

public static final int POD_RANGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static NodeNetworkConfig getDefaultInstance()
Returns
Type Description
NodeNetworkConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static NodeNetworkConfig.Builder newBuilder()
Returns
Type Description
NodeNetworkConfig.Builder

newBuilder(NodeNetworkConfig prototype)

public static NodeNetworkConfig.Builder newBuilder(NodeNetworkConfig prototype)
Parameter
Name Description
prototype NodeNetworkConfig
Returns
Type Description
NodeNetworkConfig.Builder

parseDelimitedFrom(InputStream input)

public static NodeNetworkConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NodeNetworkConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static NodeNetworkConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NodeNetworkConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NodeNetworkConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NodeNetworkConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NodeNetworkConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NodeNetworkConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static NodeNetworkConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NodeNetworkConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static NodeNetworkConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NodeNetworkConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NodeNetworkConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<NodeNetworkConfig> parser()
Returns
Type Description
Parser<NodeNetworkConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdditionalNodeNetworkConfigs(int index)

public AdditionalNodeNetworkConfig getAdditionalNodeNetworkConfigs(int index)

We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface

repeated .google.container.v1.AdditionalNodeNetworkConfig additional_node_network_configs = 14;

Parameter
Name Description
index int
Returns
Type Description
AdditionalNodeNetworkConfig

getAdditionalNodeNetworkConfigsCount()

public int getAdditionalNodeNetworkConfigsCount()

We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface

repeated .google.container.v1.AdditionalNodeNetworkConfig additional_node_network_configs = 14;

Returns
Type Description
int

getAdditionalNodeNetworkConfigsList()

public List<AdditionalNodeNetworkConfig> getAdditionalNodeNetworkConfigsList()

We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface

repeated .google.container.v1.AdditionalNodeNetworkConfig additional_node_network_configs = 14;

Returns
Type Description
List<AdditionalNodeNetworkConfig>

getAdditionalNodeNetworkConfigsOrBuilder(int index)

public AdditionalNodeNetworkConfigOrBuilder getAdditionalNodeNetworkConfigsOrBuilder(int index)

We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface

repeated .google.container.v1.AdditionalNodeNetworkConfig additional_node_network_configs = 14;

Parameter
Name Description
index int
Returns
Type Description
AdditionalNodeNetworkConfigOrBuilder

getAdditionalNodeNetworkConfigsOrBuilderList()

public List<? extends AdditionalNodeNetworkConfigOrBuilder> getAdditionalNodeNetworkConfigsOrBuilderList()

We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface

repeated .google.container.v1.AdditionalNodeNetworkConfig additional_node_network_configs = 14;

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

getAdditionalPodNetworkConfigs(int index)

public AdditionalPodNetworkConfig getAdditionalPodNetworkConfigs(int index)

We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node

repeated .google.container.v1.AdditionalPodNetworkConfig additional_pod_network_configs = 15;

Parameter
Name Description
index int
Returns
Type Description
AdditionalPodNetworkConfig

getAdditionalPodNetworkConfigsCount()

public int getAdditionalPodNetworkConfigsCount()

We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node

repeated .google.container.v1.AdditionalPodNetworkConfig additional_pod_network_configs = 15;

Returns
Type Description
int

getAdditionalPodNetworkConfigsList()

public List<AdditionalPodNetworkConfig> getAdditionalPodNetworkConfigsList()

We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node

repeated .google.container.v1.AdditionalPodNetworkConfig additional_pod_network_configs = 15;

Returns
Type Description
List<AdditionalPodNetworkConfig>

getAdditionalPodNetworkConfigsOrBuilder(int index)

public AdditionalPodNetworkConfigOrBuilder getAdditionalPodNetworkConfigsOrBuilder(int index)

We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node

repeated .google.container.v1.AdditionalPodNetworkConfig additional_pod_network_configs = 15;

Parameter
Name Description
index int
Returns
Type Description
AdditionalPodNetworkConfigOrBuilder

getAdditionalPodNetworkConfigsOrBuilderList()

public List<? extends AdditionalPodNetworkConfigOrBuilder> getAdditionalPodNetworkConfigsOrBuilderList()

We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node

repeated .google.container.v1.AdditionalPodNetworkConfig additional_pod_network_configs = 15;

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

getCreatePodRange()

public boolean getCreatePodRange()

Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for pod_range and pod_ipv4_cidr_block if they are not specified.

If neither create_pod_range or pod_range are specified, the cluster-level default (ip_allocation_policy.cluster_ipv4_cidr_block) is used.

Only applicable if ip_allocation_policy.use_ip_aliases is true.

This field cannot be changed after the node pool has been created.

bool create_pod_range = 4 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

The createPodRange.

getDefaultInstanceForType()

public NodeNetworkConfig getDefaultInstanceForType()
Returns
Type Description
NodeNetworkConfig

getEnablePrivateNodes()

public boolean getEnablePrivateNodes()

Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from cluster.privateClusterConfig.enablePrivateNodes

optional bool enable_private_nodes = 9;

Returns
Type Description
boolean

The enablePrivateNodes.

getNetworkPerformanceConfig()

public NodeNetworkConfig.NetworkPerformanceConfig getNetworkPerformanceConfig()

Network bandwidth tier configuration.

optional .google.container.v1.NodeNetworkConfig.NetworkPerformanceConfig network_performance_config = 11;

Returns
Type Description
NodeNetworkConfig.NetworkPerformanceConfig

The networkPerformanceConfig.

getNetworkPerformanceConfigOrBuilder()

public NodeNetworkConfig.NetworkPerformanceConfigOrBuilder getNetworkPerformanceConfigOrBuilder()

Network bandwidth tier configuration.

optional .google.container.v1.NodeNetworkConfig.NetworkPerformanceConfig network_performance_config = 11;

Returns
Type Description
NodeNetworkConfig.NetworkPerformanceConfigOrBuilder

getParserForType()

public Parser<NodeNetworkConfig> getParserForType()
Returns
Type Description
Parser<NodeNetworkConfig>
Overrides

getPodCidrOverprovisionConfig()

public PodCIDROverprovisionConfig getPodCidrOverprovisionConfig()

[PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool.

Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26).

This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.

.google.container.v1.PodCIDROverprovisionConfig pod_cidr_overprovision_config = 13;

Returns
Type Description
PodCIDROverprovisionConfig

The podCidrOverprovisionConfig.

getPodCidrOverprovisionConfigOrBuilder()

public PodCIDROverprovisionConfigOrBuilder getPodCidrOverprovisionConfigOrBuilder()

[PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool.

Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26).

This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.

.google.container.v1.PodCIDROverprovisionConfig pod_cidr_overprovision_config = 13;

Returns
Type Description
PodCIDROverprovisionConfigOrBuilder

getPodIpv4CidrBlock()

public String getPodIpv4CidrBlock()

The IP address range for pod IPs in this node pool.

Only applicable if create_pod_range is true.

Set to blank to have a range chosen with the default size.

Set to /netmask (e.g. /14) to have a range chosen with a specific netmask.

Set to a CIDR notation (e.g. 10.96.0.0/14) to pick a specific range to use.

Only applicable if ip_allocation_policy.use_ip_aliases is true.

This field cannot be changed after the node pool has been created.

string pod_ipv4_cidr_block = 6;

Returns
Type Description
String

The podIpv4CidrBlock.

getPodIpv4CidrBlockBytes()

public ByteString getPodIpv4CidrBlockBytes()

The IP address range for pod IPs in this node pool.

Only applicable if create_pod_range is true.

Set to blank to have a range chosen with the default size.

Set to /netmask (e.g. /14) to have a range chosen with a specific netmask.

Set to a CIDR notation (e.g. 10.96.0.0/14) to pick a specific range to use.

Only applicable if ip_allocation_policy.use_ip_aliases is true.

This field cannot be changed after the node pool has been created.

string pod_ipv4_cidr_block = 6;

Returns
Type Description
ByteString

The bytes for podIpv4CidrBlock.

getPodIpv4RangeUtilization()

public double getPodIpv4RangeUtilization()

Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodesnumZonespodIPsPerNode.

double pod_ipv4_range_utilization = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
double

The podIpv4RangeUtilization.

getPodRange()

public String getPodRange()

The ID of the secondary range for pod IPs. If create_pod_range is true, this ID is used for the new range. If create_pod_range is false, uses an existing secondary range with this ID.

Only applicable if ip_allocation_policy.use_ip_aliases is true.

This field cannot be changed after the node pool has been created.

string pod_range = 5;

Returns
Type Description
String

The podRange.

getPodRangeBytes()

public ByteString getPodRangeBytes()

The ID of the secondary range for pod IPs. If create_pod_range is true, this ID is used for the new range. If create_pod_range is false, uses an existing secondary range with this ID.

Only applicable if ip_allocation_policy.use_ip_aliases is true.

This field cannot be changed after the node pool has been created.

string pod_range = 5;

Returns
Type Description
ByteString

The bytes for podRange.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasEnablePrivateNodes()

public boolean hasEnablePrivateNodes()

Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from cluster.privateClusterConfig.enablePrivateNodes

optional bool enable_private_nodes = 9;

Returns
Type Description
boolean

Whether the enablePrivateNodes field is set.

hasNetworkPerformanceConfig()

public boolean hasNetworkPerformanceConfig()

Network bandwidth tier configuration.

optional .google.container.v1.NodeNetworkConfig.NetworkPerformanceConfig network_performance_config = 11;

Returns
Type Description
boolean

Whether the networkPerformanceConfig field is set.

hasPodCidrOverprovisionConfig()

public boolean hasPodCidrOverprovisionConfig()

[PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool.

Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26).

This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.

.google.container.v1.PodCIDROverprovisionConfig pod_cidr_overprovision_config = 13;

Returns
Type Description
boolean

Whether the podCidrOverprovisionConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public NodeNetworkConfig.Builder newBuilderForType()
Returns
Type Description
NodeNetworkConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NodeNetworkConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
NodeNetworkConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public NodeNetworkConfig.Builder toBuilder()
Returns
Type Description
NodeNetworkConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException