Interface IPAllocationPolicyOrBuilder (2.56.0) 

public interface IPAllocationPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdditionalPodRangesConfig()

public abstract AdditionalPodRangesConfig getAdditionalPodRangesConfig()

Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.

.google.container.v1.AdditionalPodRangesConfig additional_pod_ranges_config = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AdditionalPodRangesConfig

The additionalPodRangesConfig.

getAdditionalPodRangesConfigOrBuilder()

public abstract AdditionalPodRangesConfigOrBuilder getAdditionalPodRangesConfigOrBuilder()

Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.

.google.container.v1.AdditionalPodRangesConfig additional_pod_ranges_config = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AdditionalPodRangesConfigOrBuilder

getClusterIpv4Cidr() (deprecated)

public abstract String getClusterIpv4Cidr()

Deprecated. google.container.v1.IPAllocationPolicy.cluster_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1656

This field is deprecated, use cluster_ipv4_cidr_block.

string cluster_ipv4_cidr = 4 [deprecated = true];

Returns
Type Description
String

The clusterIpv4Cidr.

getClusterIpv4CidrBlock()

public abstract String getClusterIpv4CidrBlock()

The IP address range for the cluster pod IPs. If this field is set, then cluster.cluster_ipv4_cidr must be left blank.

This field is only applicable when use_ip_aliases 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

string cluster_ipv4_cidr_block = 9;

Returns
Type Description
String

The clusterIpv4CidrBlock.

getClusterIpv4CidrBlockBytes()

public abstract ByteString getClusterIpv4CidrBlockBytes()

The IP address range for the cluster pod IPs. If this field is set, then cluster.cluster_ipv4_cidr must be left blank.

This field is only applicable when use_ip_aliases 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

string cluster_ipv4_cidr_block = 9;

Returns
Type Description
ByteString

The bytes for clusterIpv4CidrBlock.

getClusterIpv4CidrBytes() (deprecated)

public abstract ByteString getClusterIpv4CidrBytes()

Deprecated. google.container.v1.IPAllocationPolicy.cluster_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1656

This field is deprecated, use cluster_ipv4_cidr_block.

string cluster_ipv4_cidr = 4 [deprecated = true];

Returns
Type Description
ByteString

The bytes for clusterIpv4Cidr.

getClusterSecondaryRangeName()

public abstract String getClusterSecondaryRangeName()

The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork.

This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

string cluster_secondary_range_name = 7;

Returns
Type Description
String

The clusterSecondaryRangeName.

getClusterSecondaryRangeNameBytes()

public abstract ByteString getClusterSecondaryRangeNameBytes()

The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork.

This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

string cluster_secondary_range_name = 7;

Returns
Type Description
ByteString

The bytes for clusterSecondaryRangeName.

getCreateSubnetwork()

public abstract boolean getCreateSubnetwork()

Whether a new subnetwork will be created automatically for the cluster.

This field is only applicable when use_ip_aliases is true.

bool create_subnetwork = 2;

Returns
Type Description
boolean

The createSubnetwork.

getDefaultPodIpv4RangeUtilization()

public abstract double getDefaultPodIpv4RangeUtilization()

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

double default_pod_ipv4_range_utilization = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
double

The defaultPodIpv4RangeUtilization.

getIpv6AccessType()

public abstract IPv6AccessType getIpv6AccessType()

The ipv6 access type (internal or external) when create_subnetwork is true

.google.container.v1.IPv6AccessType ipv6_access_type = 17;

Returns
Type Description
IPv6AccessType

The ipv6AccessType.

getIpv6AccessTypeValue()

public abstract int getIpv6AccessTypeValue()

The ipv6 access type (internal or external) when create_subnetwork is true

.google.container.v1.IPv6AccessType ipv6_access_type = 17;

Returns
Type Description
int

The enum numeric value on the wire for ipv6AccessType.

getNodeIpv4Cidr() (deprecated)

public abstract String getNodeIpv4Cidr()

Deprecated. google.container.v1.IPAllocationPolicy.node_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1659

This field is deprecated, use node_ipv4_cidr_block.

string node_ipv4_cidr = 5 [deprecated = true];

Returns
Type Description
String

The nodeIpv4Cidr.

getNodeIpv4CidrBlock()

public abstract String getNodeIpv4CidrBlock()

The IP address range of the instance IPs in this cluster.

This is applicable only if create_subnetwork 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

string node_ipv4_cidr_block = 10;

Returns
Type Description
String

The nodeIpv4CidrBlock.

getNodeIpv4CidrBlockBytes()

public abstract ByteString getNodeIpv4CidrBlockBytes()

The IP address range of the instance IPs in this cluster.

This is applicable only if create_subnetwork 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

string node_ipv4_cidr_block = 10;

Returns
Type Description
ByteString

The bytes for nodeIpv4CidrBlock.

getNodeIpv4CidrBytes() (deprecated)

public abstract ByteString getNodeIpv4CidrBytes()

Deprecated. google.container.v1.IPAllocationPolicy.node_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1659

This field is deprecated, use node_ipv4_cidr_block.

string node_ipv4_cidr = 5 [deprecated = true];

Returns
Type Description
ByteString

The bytes for nodeIpv4Cidr.

getPodCidrOverprovisionConfig()

public abstract PodCIDROverprovisionConfig getPodCidrOverprovisionConfig()

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

Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is doubled and then rounded off to next power of 2 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 = 21;

Returns
Type Description
PodCIDROverprovisionConfig

The podCidrOverprovisionConfig.

getPodCidrOverprovisionConfigOrBuilder()

public abstract PodCIDROverprovisionConfigOrBuilder getPodCidrOverprovisionConfigOrBuilder()

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

Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is doubled and then rounded off to next power of 2 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 = 21;

Returns
Type Description
PodCIDROverprovisionConfigOrBuilder

getServicesIpv4Cidr() (deprecated)

public abstract String getServicesIpv4Cidr()

Deprecated. google.container.v1.IPAllocationPolicy.services_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1662

This field is deprecated, use services_ipv4_cidr_block.

string services_ipv4_cidr = 6 [deprecated = true];

Returns
Type Description
String

The servicesIpv4Cidr.

getServicesIpv4CidrBlock()

public abstract String getServicesIpv4CidrBlock()

The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size.

This field is only applicable when use_ip_aliases 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

string services_ipv4_cidr_block = 11;

Returns
Type Description
String

The servicesIpv4CidrBlock.

getServicesIpv4CidrBlockBytes()

public abstract ByteString getServicesIpv4CidrBlockBytes()

The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size.

This field is only applicable when use_ip_aliases 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

string services_ipv4_cidr_block = 11;

Returns
Type Description
ByteString

The bytes for servicesIpv4CidrBlock.

getServicesIpv4CidrBytes() (deprecated)

public abstract ByteString getServicesIpv4CidrBytes()

Deprecated. google.container.v1.IPAllocationPolicy.services_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1662

This field is deprecated, use services_ipv4_cidr_block.

string services_ipv4_cidr = 6 [deprecated = true];

Returns
Type Description
ByteString

The bytes for servicesIpv4Cidr.

getServicesIpv6CidrBlock()

public abstract String getServicesIpv6CidrBlock()

Output only. The services IPv6 CIDR block for the cluster.

string services_ipv6_cidr_block = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The servicesIpv6CidrBlock.

getServicesIpv6CidrBlockBytes()

public abstract ByteString getServicesIpv6CidrBlockBytes()

Output only. The services IPv6 CIDR block for the cluster.

string services_ipv6_cidr_block = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for servicesIpv6CidrBlock.

getServicesSecondaryRangeName()

public abstract String getServicesSecondaryRangeName()

The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork.

This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

string services_secondary_range_name = 8;

Returns
Type Description
String

The servicesSecondaryRangeName.

getServicesSecondaryRangeNameBytes()

public abstract ByteString getServicesSecondaryRangeNameBytes()

The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork.

This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

string services_secondary_range_name = 8;

Returns
Type Description
ByteString

The bytes for servicesSecondaryRangeName.

getStackType()

public abstract StackType getStackType()

The IP stack type of the cluster

.google.container.v1.StackType stack_type = 16;

Returns
Type Description
StackType

The stackType.

getStackTypeValue()

public abstract int getStackTypeValue()

The IP stack type of the cluster

.google.container.v1.StackType stack_type = 16;

Returns
Type Description
int

The enum numeric value on the wire for stackType.

getSubnetIpv6CidrBlock()

public abstract String getSubnetIpv6CidrBlock()

Output only. The subnet's IPv6 CIDR block used by nodes and pods.

string subnet_ipv6_cidr_block = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The subnetIpv6CidrBlock.

getSubnetIpv6CidrBlockBytes()

public abstract ByteString getSubnetIpv6CidrBlockBytes()

Output only. The subnet's IPv6 CIDR block used by nodes and pods.

string subnet_ipv6_cidr_block = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for subnetIpv6CidrBlock.

getSubnetworkName()

public abstract String getSubnetworkName()

A custom subnetwork name to be used if create_subnetwork is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.

string subnetwork_name = 3;

Returns
Type Description
String

The subnetworkName.

getSubnetworkNameBytes()

public abstract ByteString getSubnetworkNameBytes()

A custom subnetwork name to be used if create_subnetwork is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.

string subnetwork_name = 3;

Returns
Type Description
ByteString

The bytes for subnetworkName.

getTpuIpv4CidrBlock()

public abstract String getTpuIpv4CidrBlock()

The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size.

This field is only applicable when use_ip_aliases is true.

If unspecified, the range will use 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

string tpu_ipv4_cidr_block = 13;

Returns
Type Description
String

The tpuIpv4CidrBlock.

getTpuIpv4CidrBlockBytes()

public abstract ByteString getTpuIpv4CidrBlockBytes()

The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size.

This field is only applicable when use_ip_aliases is true.

If unspecified, the range will use 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

string tpu_ipv4_cidr_block = 13;

Returns
Type Description
ByteString

The bytes for tpuIpv4CidrBlock.

getUseIpAliases()

public abstract boolean getUseIpAliases()

Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

bool use_ip_aliases = 1;

Returns
Type Description
boolean

The useIpAliases.

getUseRoutes()

public abstract boolean getUseRoutes()

Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

bool use_routes = 15;

Returns
Type Description
boolean

The useRoutes.

hasAdditionalPodRangesConfig()

public abstract boolean hasAdditionalPodRangesConfig()

Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.

.google.container.v1.AdditionalPodRangesConfig additional_pod_ranges_config = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the additionalPodRangesConfig field is set.

hasPodCidrOverprovisionConfig()

public abstract boolean hasPodCidrOverprovisionConfig()

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

Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is doubled and then rounded off to next power of 2 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 = 21;

Returns
Type Description
boolean

Whether the podCidrOverprovisionConfig field is set.