/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/container/v1/cluster_service.proto
package com.google.container.v1;
public interface IPAllocationPolicyOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.container.v1.IPAllocationPolicy)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return The useIpAliases.
*/
boolean getUseIpAliases();
/**
*
*
*
* 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;
*
* @return The createSubnetwork.
*/
boolean getCreateSubnetwork();
/**
*
*
*
* 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;
*
* @return The subnetworkName.
*/
java.lang.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;
*
* @return The bytes for subnetworkName.
*/
com.google.protobuf.ByteString getSubnetworkNameBytes();
/**
*
*
*
* This field is deprecated, use cluster_ipv4_cidr_block.
*
*
* string cluster_ipv4_cidr = 4 [deprecated = true];
*
* @deprecated google.container.v1.IPAllocationPolicy.cluster_ipv4_cidr is deprecated. See
* google/container/v1/cluster_service.proto;l=1377
* @return The clusterIpv4Cidr.
*/
@java.lang.Deprecated
java.lang.String getClusterIpv4Cidr();
/**
*
*
*
* This field is deprecated, use cluster_ipv4_cidr_block.
*
*
* string cluster_ipv4_cidr = 4 [deprecated = true];
*
* @deprecated google.container.v1.IPAllocationPolicy.cluster_ipv4_cidr is deprecated. See
* google/container/v1/cluster_service.proto;l=1377
* @return The bytes for clusterIpv4Cidr.
*/
@java.lang.Deprecated
com.google.protobuf.ByteString getClusterIpv4CidrBytes();
/**
*
*
*
* This field is deprecated, use node_ipv4_cidr_block.
*
*
* string node_ipv4_cidr = 5 [deprecated = true];
*
* @deprecated google.container.v1.IPAllocationPolicy.node_ipv4_cidr is deprecated. See
* google/container/v1/cluster_service.proto;l=1380
* @return The nodeIpv4Cidr.
*/
@java.lang.Deprecated
java.lang.String getNodeIpv4Cidr();
/**
*
*
*
* This field is deprecated, use node_ipv4_cidr_block.
*
*
* string node_ipv4_cidr = 5 [deprecated = true];
*
* @deprecated google.container.v1.IPAllocationPolicy.node_ipv4_cidr is deprecated. See
* google/container/v1/cluster_service.proto;l=1380
* @return The bytes for nodeIpv4Cidr.
*/
@java.lang.Deprecated
com.google.protobuf.ByteString getNodeIpv4CidrBytes();
/**
*
*
*
* This field is deprecated, use services_ipv4_cidr_block.
*
*
* string services_ipv4_cidr = 6 [deprecated = true];
*
* @deprecated google.container.v1.IPAllocationPolicy.services_ipv4_cidr is deprecated. See
* google/container/v1/cluster_service.proto;l=1383
* @return The servicesIpv4Cidr.
*/
@java.lang.Deprecated
java.lang.String getServicesIpv4Cidr();
/**
*
*
*
* This field is deprecated, use services_ipv4_cidr_block.
*
*
* string services_ipv4_cidr = 6 [deprecated = true];
*
* @deprecated google.container.v1.IPAllocationPolicy.services_ipv4_cidr is deprecated. See
* google/container/v1/cluster_service.proto;l=1383
* @return The bytes for servicesIpv4Cidr.
*/
@java.lang.Deprecated
com.google.protobuf.ByteString getServicesIpv4CidrBytes();
/**
*
*
*
* 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;
*
* @return The clusterSecondaryRangeName.
*/
java.lang.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;
*
* @return The bytes for clusterSecondaryRangeName.
*/
com.google.protobuf.ByteString getClusterSecondaryRangeNameBytes();
/**
*
*
*
* 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;
*
* @return The servicesSecondaryRangeName.
*/
java.lang.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;
*
* @return The bytes for servicesSecondaryRangeName.
*/
com.google.protobuf.ByteString getServicesSecondaryRangeNameBytes();
/**
*
*
*
* 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
* 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;
*
* @return The clusterIpv4CidrBlock.
*/
java.lang.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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
* 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;
*
* @return The bytes for clusterIpv4CidrBlock.
*/
com.google.protobuf.ByteString getClusterIpv4CidrBlockBytes();
/**
*
*
*
* 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
* 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;
*
* @return The nodeIpv4CidrBlock.
*/
java.lang.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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
* 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;
*
* @return The bytes for nodeIpv4CidrBlock.
*/
com.google.protobuf.ByteString getNodeIpv4CidrBlockBytes();
/**
*
*
*
* 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
* 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;
*
* @return The servicesIpv4CidrBlock.
*/
java.lang.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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
* 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;
*
* @return The bytes for servicesIpv4CidrBlock.
*/
com.google.protobuf.ByteString getServicesIpv4CidrBlockBytes();
/**
*
*
*
* 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
* 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;
*
* @return The tpuIpv4CidrBlock.
*/
java.lang.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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
* 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;
*
* @return The bytes for tpuIpv4CidrBlock.
*/
com.google.protobuf.ByteString getTpuIpv4CidrBlockBytes();
/**
*
*
*
* 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;
*
* @return The useRoutes.
*/
boolean getUseRoutes();
/**
*
*
*
* The IP stack type of the cluster
*
*
* .google.container.v1.StackType stack_type = 16;
*
* @return The enum numeric value on the wire for stackType.
*/
int getStackTypeValue();
/**
*
*
*
* The IP stack type of the cluster
*
*
* .google.container.v1.StackType stack_type = 16;
*
* @return The stackType.
*/
com.google.container.v1.StackType getStackType();
/**
*
*
*
* The ipv6 access type (internal or external) when create_subnetwork is true
*
*
* .google.container.v1.IPv6AccessType ipv6_access_type = 17;
*
* @return The enum numeric value on the wire for ipv6AccessType.
*/
int getIpv6AccessTypeValue();
/**
*
*
*
* The ipv6 access type (internal or external) when create_subnetwork is true
*
*
* .google.container.v1.IPv6AccessType ipv6_access_type = 17;
*
* @return The ipv6AccessType.
*/
com.google.container.v1.IPv6AccessType getIpv6AccessType();
/**
*
*
*
* [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;
*
*
* @return Whether the podCidrOverprovisionConfig field is set.
*/
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;
*
*
* @return The podCidrOverprovisionConfig.
*/
com.google.container.v1.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;
*
*/
com.google.container.v1.PodCIDROverprovisionConfigOrBuilder
getPodCidrOverprovisionConfigOrBuilder();
/**
*
*
*
* 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];
*
* @return The subnetIpv6CidrBlock.
*/
java.lang.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];
*
* @return The bytes for subnetIpv6CidrBlock.
*/
com.google.protobuf.ByteString getSubnetIpv6CidrBlockBytes();
/**
*
*
*
* Output only. [Output only] The services IPv6 CIDR block for the cluster.
*
*
* string services_ipv6_cidr_block = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The servicesIpv6CidrBlock.
*/
java.lang.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];
*
* @return The bytes for servicesIpv6CidrBlock.
*/
com.google.protobuf.ByteString getServicesIpv6CidrBlockBytes();
/**
*
*
*
* Output only. [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];
*
*
* @return Whether the additionalPodRangesConfig field is set.
*/
boolean hasAdditionalPodRangesConfig();
/**
*
*
*
* Output only. [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];
*
*
* @return The additionalPodRangesConfig.
*/
com.google.container.v1.AdditionalPodRangesConfig getAdditionalPodRangesConfig();
/**
*
*
*
* Output only. [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];
*
*/
com.google.container.v1.AdditionalPodRangesConfigOrBuilder
getAdditionalPodRangesConfigOrBuilder();
}