Package com.google.container.v1

Interface IPAllocationPolicyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    IPAllocationPolicy, IPAllocationPolicy.Builder
    public interface IPAllocationPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getUseIpAliases

        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:
        The useIpAliases.

      • getCreateSubnetwork

        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:
        The createSubnetwork.

      • getSubnetworkName

        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:
        The subnetworkName.

      • getSubnetworkNameBytes

        com.google.protobuf.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:
        The bytes for subnetworkName.

      • getClusterIpv4Cidr

        @Deprecated
String getClusterIpv4Cidr()
        Deprecated.
        google.container.v1.IPAllocationPolicy.cluster_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1473
         This field is deprecated, use cluster_ipv4_cidr_block.
        string cluster_ipv4_cidr = 4 [deprecated = true];
        Returns:
        The clusterIpv4Cidr.

      • getClusterIpv4CidrBytes

        @Deprecated
com.google.protobuf.ByteString getClusterIpv4CidrBytes()
        Deprecated.
        google.container.v1.IPAllocationPolicy.cluster_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1473
         This field is deprecated, use cluster_ipv4_cidr_block.
        string cluster_ipv4_cidr = 4 [deprecated = true];
        Returns:
        The bytes for clusterIpv4Cidr.

      • getNodeIpv4Cidr

        @Deprecated
String getNodeIpv4Cidr()
        Deprecated.
        google.container.v1.IPAllocationPolicy.node_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1476
         This field is deprecated, use node_ipv4_cidr_block.
        string node_ipv4_cidr = 5 [deprecated = true];
        Returns:
        The nodeIpv4Cidr.

      • getNodeIpv4CidrBytes

        @Deprecated
com.google.protobuf.ByteString getNodeIpv4CidrBytes()
        Deprecated.
        google.container.v1.IPAllocationPolicy.node_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1476
         This field is deprecated, use node_ipv4_cidr_block.
        string node_ipv4_cidr = 5 [deprecated = true];
        Returns:
        The bytes for nodeIpv4Cidr.

      • getServicesIpv4Cidr

        @Deprecated
String getServicesIpv4Cidr()
        Deprecated.
        google.container.v1.IPAllocationPolicy.services_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1479
         This field is deprecated, use services_ipv4_cidr_block.
        string services_ipv4_cidr = 6 [deprecated = true];
        Returns:
        The servicesIpv4Cidr.

      • getServicesIpv4CidrBytes

        @Deprecated
com.google.protobuf.ByteString getServicesIpv4CidrBytes()
        Deprecated.
        google.container.v1.IPAllocationPolicy.services_ipv4_cidr is deprecated. See google/container/v1/cluster_service.proto;l=1479
         This field is deprecated, use services_ipv4_cidr_block.
        string services_ipv4_cidr = 6 [deprecated = true];
        Returns:
        The bytes for servicesIpv4Cidr.

      • getClusterSecondaryRangeName

        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:
        The clusterSecondaryRangeName.

      • getClusterSecondaryRangeNameBytes

        com.google.protobuf.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:
        The bytes for clusterSecondaryRangeName.

      • getServicesSecondaryRangeName

        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:
        The servicesSecondaryRangeName.

      • getServicesSecondaryRangeNameBytes

        com.google.protobuf.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:
        The bytes for servicesSecondaryRangeName.

      • getClusterIpv4CidrBlock

        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;
        Returns:
        The clusterIpv4CidrBlock.

      • getClusterIpv4CidrBlockBytes

        com.google.protobuf.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](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;
        Returns:
        The bytes for clusterIpv4CidrBlock.

      • getNodeIpv4CidrBlock

        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;
        Returns:
        The nodeIpv4CidrBlock.

      • getNodeIpv4CidrBlockBytes

        com.google.protobuf.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](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;
        Returns:
        The bytes for nodeIpv4CidrBlock.

      • getServicesIpv4CidrBlock

        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;
        Returns:
        The servicesIpv4CidrBlock.

      • getServicesIpv4CidrBlockBytes

        com.google.protobuf.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](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;
        Returns:
        The bytes for servicesIpv4CidrBlock.

      • getTpuIpv4CidrBlock

        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;
        Returns:
        The tpuIpv4CidrBlock.

      • getTpuIpv4CidrBlockBytes

        com.google.protobuf.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](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;
        Returns:
        The bytes for tpuIpv4CidrBlock.

      • getUseRoutes

        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:
        The useRoutes.

      • getStackTypeValue

        int getStackTypeValue()
         The IP stack type of the cluster
        .google.container.v1.StackType stack_type = 16;
        Returns:
        The enum numeric value on the wire for stackType.

      • getStackType

        StackType getStackType()
         The IP stack type of the cluster
        .google.container.v1.StackType stack_type = 16;
        Returns:
        The stackType.

      • getIpv6AccessTypeValue

        int getIpv6AccessTypeValue()
         The ipv6 access type (internal or external) when create_subnetwork is true
        .google.container.v1.IPv6AccessType ipv6_access_type = 17;
        Returns:
        The enum numeric value on the wire for ipv6AccessType.

      • getIpv6AccessType

        IPv6AccessType getIpv6AccessType()
         The ipv6 access type (internal or external) when create_subnetwork is true
        .google.container.v1.IPv6AccessType ipv6_access_type = 17;
        Returns:
        The ipv6AccessType.

      • hasPodCidrOverprovisionConfig

        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:
        Whether the podCidrOverprovisionConfig field is set.

      • getPodCidrOverprovisionConfig

        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:
        The podCidrOverprovisionConfig.

      • getPodCidrOverprovisionConfigOrBuilder

        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;

      • getSubnetIpv6CidrBlock

        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:
        The subnetIpv6CidrBlock.

      • getSubnetIpv6CidrBlockBytes

        com.google.protobuf.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:
        The bytes for subnetIpv6CidrBlock.

      • getServicesIpv6CidrBlock

        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:
        The servicesIpv6CidrBlock.

      • getServicesIpv6CidrBlockBytes

        com.google.protobuf.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:
        The bytes for servicesIpv6CidrBlock.

      • hasAdditionalPodRangesConfig

        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];
        Returns:
        Whether the additionalPodRangesConfig field is set.

      • getAdditionalPodRangesConfig

        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];
        Returns:
        The additionalPodRangesConfig.

      • getAdditionalPodRangesConfigOrBuilder

        AdditionalPodRangesConfigOrBuilder getAdditionalPodRangesConfigOrBuilder()
         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];

      • getDefaultPodIpv4RangeUtilization

        double getDefaultPodIpv4RangeUtilization()
         Output only. [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=numNodes*numZones*podIPsPerNode.
        double default_pod_ipv4_range_utilization = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The defaultPodIpv4RangeUtilization.