Class IPAllocationPolicy (2.5.2)

Stay organized with collections Save and categorize content based on your preferences.
public final class IPAllocationPolicy extends GeneratedMessageV3 implements IPAllocationPolicyOrBuilder

Configuration for controlling how IPs are allocated in the cluster.

Protobuf type google.container.v1beta1.IPAllocationPolicy

Static Fields

ALLOW_ROUTE_OVERLAP_FIELD_NUMBER

public static final int ALLOW_ROUTE_OVERLAP_FIELD_NUMBER
Field Value
TypeDescription
int

CLUSTER_IPV4_CIDR_BLOCK_FIELD_NUMBER

public static final int CLUSTER_IPV4_CIDR_BLOCK_FIELD_NUMBER
Field Value
TypeDescription
int

CLUSTER_IPV4_CIDR_FIELD_NUMBER

public static final int CLUSTER_IPV4_CIDR_FIELD_NUMBER
Field Value
TypeDescription
int

CLUSTER_SECONDARY_RANGE_NAME_FIELD_NUMBER

public static final int CLUSTER_SECONDARY_RANGE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_SUBNETWORK_FIELD_NUMBER

public static final int CREATE_SUBNETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

IPV6_ACCESS_TYPE_FIELD_NUMBER

public static final int IPV6_ACCESS_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_IPV4_CIDR_BLOCK_FIELD_NUMBER

public static final int NODE_IPV4_CIDR_BLOCK_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_IPV4_CIDR_FIELD_NUMBER

public static final int NODE_IPV4_CIDR_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICES_IPV4_CIDR_BLOCK_FIELD_NUMBER

public static final int SERVICES_IPV4_CIDR_BLOCK_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICES_IPV4_CIDR_FIELD_NUMBER

public static final int SERVICES_IPV4_CIDR_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICES_IPV6_CIDR_BLOCK_FIELD_NUMBER

public static final int SERVICES_IPV6_CIDR_BLOCK_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICES_SECONDARY_RANGE_NAME_FIELD_NUMBER

public static final int SERVICES_SECONDARY_RANGE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STACK_TYPE_FIELD_NUMBER

public static final int STACK_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNETWORK_NAME_FIELD_NUMBER

public static final int SUBNETWORK_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNET_IPV6_CIDR_BLOCK_FIELD_NUMBER

public static final int SUBNET_IPV6_CIDR_BLOCK_FIELD_NUMBER
Field Value
TypeDescription
int

TPU_IPV4_CIDR_BLOCK_FIELD_NUMBER

public static final int TPU_IPV4_CIDR_BLOCK_FIELD_NUMBER
Field Value
TypeDescription
int

USE_IP_ALIASES_FIELD_NUMBER

public static final int USE_IP_ALIASES_FIELD_NUMBER
Field Value
TypeDescription
int

USE_ROUTES_FIELD_NUMBER

public static final int USE_ROUTES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static IPAllocationPolicy getDefaultInstance()
Returns
TypeDescription
IPAllocationPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static IPAllocationPolicy.Builder newBuilder()
Returns
TypeDescription
IPAllocationPolicy.Builder

newBuilder(IPAllocationPolicy prototype)

public static IPAllocationPolicy.Builder newBuilder(IPAllocationPolicy prototype)
Parameter
NameDescription
prototypeIPAllocationPolicy
Returns
TypeDescription
IPAllocationPolicy.Builder

parseDelimitedFrom(InputStream input)

public static IPAllocationPolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IPAllocationPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static IPAllocationPolicy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IPAllocationPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IPAllocationPolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IPAllocationPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IPAllocationPolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IPAllocationPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static IPAllocationPolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IPAllocationPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static IPAllocationPolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IPAllocationPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IPAllocationPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<IPAllocationPolicy> parser()
Returns
TypeDescription
Parser<IPAllocationPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAllowRouteOverlap()

public boolean getAllowRouteOverlap()

If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. 10.96.0.0/14, but not /14), which means: 1) When use_ip_aliases is true, cluster_ipv4_cidr_block and services_ipv4_cidr_block must be fully-specified. 2) When use_ip_aliases is false, cluster.cluster_ipv4_cidr muse be fully-specified.

bool allow_route_overlap = 12;

Returns
TypeDescription
boolean

The allowRouteOverlap.

getClusterIpv4Cidr() (deprecated)

public String getClusterIpv4Cidr()

Deprecated. google.container.v1beta1.IPAllocationPolicy.cluster_ipv4_cidr is deprecated. See google/container/v1beta1/cluster_service.proto;l=1305

This field is deprecated, use cluster_ipv4_cidr_block.

string cluster_ipv4_cidr = 4 [deprecated = true];

Returns
TypeDescription
String

The clusterIpv4Cidr.

getClusterIpv4CidrBlock()

public 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
TypeDescription
String

The clusterIpv4CidrBlock.

getClusterIpv4CidrBlockBytes()

public 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
TypeDescription
ByteString

The bytes for clusterIpv4CidrBlock.

getClusterIpv4CidrBytes() (deprecated)

public ByteString getClusterIpv4CidrBytes()

Deprecated. google.container.v1beta1.IPAllocationPolicy.cluster_ipv4_cidr is deprecated. See google/container/v1beta1/cluster_service.proto;l=1305

This field is deprecated, use cluster_ipv4_cidr_block.

string cluster_ipv4_cidr = 4 [deprecated = true];

Returns
TypeDescription
ByteString

The bytes for clusterIpv4Cidr.

getClusterSecondaryRangeName()

public 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 and create_subnetwork is false.

string cluster_secondary_range_name = 7;

Returns
TypeDescription
String

The clusterSecondaryRangeName.

getClusterSecondaryRangeNameBytes()

public 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 and create_subnetwork is false.

string cluster_secondary_range_name = 7;

Returns
TypeDescription
ByteString

The bytes for clusterSecondaryRangeName.

getCreateSubnetwork()

public 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
TypeDescription
boolean

The createSubnetwork.

getDefaultInstanceForType()

public IPAllocationPolicy getDefaultInstanceForType()
Returns
TypeDescription
IPAllocationPolicy

getIpv6AccessType()

public IPAllocationPolicy.IPv6AccessType getIpv6AccessType()

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

.google.container.v1beta1.IPAllocationPolicy.IPv6AccessType ipv6_access_type = 17;

Returns
TypeDescription
IPAllocationPolicy.IPv6AccessType

The ipv6AccessType.

getIpv6AccessTypeValue()

public int getIpv6AccessTypeValue()

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

.google.container.v1beta1.IPAllocationPolicy.IPv6AccessType ipv6_access_type = 17;

Returns
TypeDescription
int

The enum numeric value on the wire for ipv6AccessType.

getNodeIpv4Cidr() (deprecated)

public String getNodeIpv4Cidr()

Deprecated. google.container.v1beta1.IPAllocationPolicy.node_ipv4_cidr is deprecated. See google/container/v1beta1/cluster_service.proto;l=1308

This field is deprecated, use node_ipv4_cidr_block.

string node_ipv4_cidr = 5 [deprecated = true];

Returns
TypeDescription
String

The nodeIpv4Cidr.

getNodeIpv4CidrBlock()

public 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
TypeDescription
String

The nodeIpv4CidrBlock.

getNodeIpv4CidrBlockBytes()

public 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
TypeDescription
ByteString

The bytes for nodeIpv4CidrBlock.

getNodeIpv4CidrBytes() (deprecated)

public ByteString getNodeIpv4CidrBytes()

Deprecated. google.container.v1beta1.IPAllocationPolicy.node_ipv4_cidr is deprecated. See google/container/v1beta1/cluster_service.proto;l=1308

This field is deprecated, use node_ipv4_cidr_block.

string node_ipv4_cidr = 5 [deprecated = true];

Returns
TypeDescription
ByteString

The bytes for nodeIpv4Cidr.

getParserForType()

public Parser<IPAllocationPolicy> getParserForType()
Returns
TypeDescription
Parser<IPAllocationPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServicesIpv4Cidr() (deprecated)

public String getServicesIpv4Cidr()

Deprecated. google.container.v1beta1.IPAllocationPolicy.services_ipv4_cidr is deprecated. See google/container/v1beta1/cluster_service.proto;l=1311

This field is deprecated, use services_ipv4_cidr_block.

string services_ipv4_cidr = 6 [deprecated = true];

Returns
TypeDescription
String

The servicesIpv4Cidr.

getServicesIpv4CidrBlock()

public 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
TypeDescription
String

The servicesIpv4CidrBlock.

getServicesIpv4CidrBlockBytes()

public 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
TypeDescription
ByteString

The bytes for servicesIpv4CidrBlock.

getServicesIpv4CidrBytes() (deprecated)

public ByteString getServicesIpv4CidrBytes()

Deprecated. google.container.v1beta1.IPAllocationPolicy.services_ipv4_cidr is deprecated. See google/container/v1beta1/cluster_service.proto;l=1311

This field is deprecated, use services_ipv4_cidr_block.

string services_ipv4_cidr = 6 [deprecated = true];

Returns
TypeDescription
ByteString

The bytes for servicesIpv4Cidr.

getServicesIpv6CidrBlock()

public String getServicesIpv6CidrBlock()

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

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

Returns
TypeDescription
String

The servicesIpv6CidrBlock.

getServicesIpv6CidrBlockBytes()

public ByteString getServicesIpv6CidrBlockBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for servicesIpv6CidrBlock.

getServicesSecondaryRangeName()

public 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 and create_subnetwork is false.

string services_secondary_range_name = 8;

Returns
TypeDescription
String

The servicesSecondaryRangeName.

getServicesSecondaryRangeNameBytes()

public 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 and create_subnetwork is false.

string services_secondary_range_name = 8;

Returns
TypeDescription
ByteString

The bytes for servicesSecondaryRangeName.

getStackType()

public IPAllocationPolicy.StackType getStackType()

IP stack type

.google.container.v1beta1.IPAllocationPolicy.StackType stack_type = 16;

Returns
TypeDescription
IPAllocationPolicy.StackType

The stackType.

getStackTypeValue()

public int getStackTypeValue()

IP stack type

.google.container.v1beta1.IPAllocationPolicy.StackType stack_type = 16;

Returns
TypeDescription
int

The enum numeric value on the wire for stackType.

getSubnetIpv6CidrBlock()

public String getSubnetIpv6CidrBlock()

Output only. [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
TypeDescription
String

The subnetIpv6CidrBlock.

getSubnetIpv6CidrBlockBytes()

public ByteString getSubnetIpv6CidrBlockBytes()

Output only. [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
TypeDescription
ByteString

The bytes for subnetIpv6CidrBlock.

getSubnetworkName()

public 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
TypeDescription
String

The subnetworkName.

getSubnetworkNameBytes()

public 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
TypeDescription
ByteString

The bytes for subnetworkName.

getTpuIpv4CidrBlock()

public 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. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

string tpu_ipv4_cidr_block = 13;

Returns
TypeDescription
String

The tpuIpv4CidrBlock.

getTpuIpv4CidrBlockBytes()

public 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. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

string tpu_ipv4_cidr_block = 13;

Returns
TypeDescription
ByteString

The bytes for tpuIpv4CidrBlock.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()