container  v1
Public Member Functions | Static Public Member Functions | List of all members
google_container_api::IPAllocationPolicy Class Reference

#include <ipa_llocation_policy.h>

Inheritance diagram for google_container_api::IPAllocationPolicy:

Public Member Functions

 IPAllocationPolicy (const Json::Value &storage)
 
 IPAllocationPolicy (Json::Value *storage)
 
virtual ~IPAllocationPolicy ()
 
const StringPiece GetTypeName () const
 
bool has_cluster_ipv4_cidr () const
 
void clear_cluster_ipv4_cidr ()
 
const StringPiece get_cluster_ipv4_cidr () const
 
void set_cluster_ipv4_cidr (const StringPiece &value)
 
bool has_cluster_ipv4_cidr_block () const
 
void clear_cluster_ipv4_cidr_block ()
 
const StringPiece get_cluster_ipv4_cidr_block () const
 
void set_cluster_ipv4_cidr_block (const StringPiece &value)
 
bool has_cluster_secondary_range_name () const
 
void clear_cluster_secondary_range_name ()
 
const StringPiece get_cluster_secondary_range_name () const
 
void set_cluster_secondary_range_name (const StringPiece &value)
 
bool has_create_subnetwork () const
 
void clear_create_subnetwork ()
 
bool get_create_subnetwork () const
 
void set_create_subnetwork (bool value)
 
bool has_node_ipv4_cidr () const
 
void clear_node_ipv4_cidr ()
 
const StringPiece get_node_ipv4_cidr () const
 
void set_node_ipv4_cidr (const StringPiece &value)
 
bool has_node_ipv4_cidr_block () const
 
void clear_node_ipv4_cidr_block ()
 
const StringPiece get_node_ipv4_cidr_block () const
 
void set_node_ipv4_cidr_block (const StringPiece &value)
 
bool has_services_ipv4_cidr () const
 
void clear_services_ipv4_cidr ()
 
const StringPiece get_services_ipv4_cidr () const
 
void set_services_ipv4_cidr (const StringPiece &value)
 
bool has_services_ipv4_cidr_block () const
 
void clear_services_ipv4_cidr_block ()
 
const StringPiece get_services_ipv4_cidr_block () const
 
void set_services_ipv4_cidr_block (const StringPiece &value)
 
bool has_services_secondary_range_name () const
 
void clear_services_secondary_range_name ()
 
const StringPiece get_services_secondary_range_name () const
 
void set_services_secondary_range_name (const StringPiece &value)
 
bool has_subnetwork_name () const
 
void clear_subnetwork_name ()
 
const StringPiece get_subnetwork_name () const
 
void set_subnetwork_name (const StringPiece &value)
 
bool has_tpu_ipv4_cidr_block () const
 
void clear_tpu_ipv4_cidr_block ()
 
const StringPiece get_tpu_ipv4_cidr_block () const
 
void set_tpu_ipv4_cidr_block (const StringPiece &value)
 
bool has_use_ip_aliases () const
 
void clear_use_ip_aliases ()
 
bool get_use_ip_aliases () const
 
void set_use_ip_aliases (bool value)
 

Static Public Member Functions

static IPAllocationPolicyNew ()
 

Detailed Description

Configuration for controlling how IPs are allocated in the cluster.

Constructor & Destructor Documentation

◆ IPAllocationPolicy() [1/2]

google_container_api::IPAllocationPolicy::IPAllocationPolicy ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ IPAllocationPolicy() [2/2]

google_container_api::IPAllocationPolicy::IPAllocationPolicy ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~IPAllocationPolicy()

google_container_api::IPAllocationPolicy::~IPAllocationPolicy ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_cluster_ipv4_cidr()

void google_container_api::IPAllocationPolicy::clear_cluster_ipv4_cidr ( )
inline

Clears the 'clusterIpv4Cidr' attribute.

◆ clear_cluster_ipv4_cidr_block()

void google_container_api::IPAllocationPolicy::clear_cluster_ipv4_cidr_block ( )
inline

Clears the 'clusterIpv4CidrBlock' attribute.

◆ clear_cluster_secondary_range_name()

void google_container_api::IPAllocationPolicy::clear_cluster_secondary_range_name ( )
inline

Clears the 'clusterSecondaryRangeName' attribute.

◆ clear_create_subnetwork()

void google_container_api::IPAllocationPolicy::clear_create_subnetwork ( )
inline

Clears the 'createSubnetwork' attribute.

◆ clear_node_ipv4_cidr()

void google_container_api::IPAllocationPolicy::clear_node_ipv4_cidr ( )
inline

Clears the 'nodeIpv4Cidr' attribute.

◆ clear_node_ipv4_cidr_block()

void google_container_api::IPAllocationPolicy::clear_node_ipv4_cidr_block ( )
inline

Clears the 'nodeIpv4CidrBlock' attribute.

◆ clear_services_ipv4_cidr()

void google_container_api::IPAllocationPolicy::clear_services_ipv4_cidr ( )
inline

Clears the 'servicesIpv4Cidr' attribute.

◆ clear_services_ipv4_cidr_block()

void google_container_api::IPAllocationPolicy::clear_services_ipv4_cidr_block ( )
inline

Clears the 'servicesIpv4CidrBlock' attribute.

◆ clear_services_secondary_range_name()

void google_container_api::IPAllocationPolicy::clear_services_secondary_range_name ( )
inline

Clears the 'servicesSecondaryRangeName' attribute.

◆ clear_subnetwork_name()

void google_container_api::IPAllocationPolicy::clear_subnetwork_name ( )
inline

Clears the 'subnetworkName' attribute.

◆ clear_tpu_ipv4_cidr_block()

void google_container_api::IPAllocationPolicy::clear_tpu_ipv4_cidr_block ( )
inline

Clears the 'tpuIpv4CidrBlock' attribute.

◆ clear_use_ip_aliases()

void google_container_api::IPAllocationPolicy::clear_use_ip_aliases ( )
inline

Clears the 'useIpAliases' attribute.

◆ get_cluster_ipv4_cidr()

const StringPiece google_container_api::IPAllocationPolicy::get_cluster_ipv4_cidr ( ) const
inline

Get the value of the 'clusterIpv4Cidr' attribute.

◆ get_cluster_ipv4_cidr_block()

const StringPiece google_container_api::IPAllocationPolicy::get_cluster_ipv4_cidr_block ( ) const
inline

Get the value of the 'clusterIpv4CidrBlock' attribute.

◆ get_cluster_secondary_range_name()

const StringPiece google_container_api::IPAllocationPolicy::get_cluster_secondary_range_name ( ) const
inline

Get the value of the 'clusterSecondaryRangeName' attribute.

◆ get_create_subnetwork()

bool google_container_api::IPAllocationPolicy::get_create_subnetwork ( ) const
inline

Get the value of the 'createSubnetwork' attribute.

◆ get_node_ipv4_cidr()

const StringPiece google_container_api::IPAllocationPolicy::get_node_ipv4_cidr ( ) const
inline

Get the value of the 'nodeIpv4Cidr' attribute.

◆ get_node_ipv4_cidr_block()

const StringPiece google_container_api::IPAllocationPolicy::get_node_ipv4_cidr_block ( ) const
inline

Get the value of the 'nodeIpv4CidrBlock' attribute.

◆ get_services_ipv4_cidr()

const StringPiece google_container_api::IPAllocationPolicy::get_services_ipv4_cidr ( ) const
inline

Get the value of the 'servicesIpv4Cidr' attribute.

◆ get_services_ipv4_cidr_block()

const StringPiece google_container_api::IPAllocationPolicy::get_services_ipv4_cidr_block ( ) const
inline

Get the value of the 'servicesIpv4CidrBlock' attribute.

◆ get_services_secondary_range_name()

const StringPiece google_container_api::IPAllocationPolicy::get_services_secondary_range_name ( ) const
inline

Get the value of the 'servicesSecondaryRangeName' attribute.

◆ get_subnetwork_name()

const StringPiece google_container_api::IPAllocationPolicy::get_subnetwork_name ( ) const
inline

Get the value of the 'subnetworkName' attribute.

◆ get_tpu_ipv4_cidr_block()

const StringPiece google_container_api::IPAllocationPolicy::get_tpu_ipv4_cidr_block ( ) const
inline

Get the value of the 'tpuIpv4CidrBlock' attribute.

◆ get_use_ip_aliases()

bool google_container_api::IPAllocationPolicy::get_use_ip_aliases ( ) const
inline

Get the value of the 'useIpAliases' attribute.

◆ GetTypeName()

const StringPiece google_container_api::IPAllocationPolicy::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_container_api::IPAllocationPolicy

◆ has_cluster_ipv4_cidr()

bool google_container_api::IPAllocationPolicy::has_cluster_ipv4_cidr ( ) const
inline

Determine if the 'clusterIpv4Cidr' attribute was set.

Returns
true if the 'clusterIpv4Cidr' attribute was set.

◆ has_cluster_ipv4_cidr_block()

bool google_container_api::IPAllocationPolicy::has_cluster_ipv4_cidr_block ( ) const
inline

Determine if the 'clusterIpv4CidrBlock' attribute was set.

Returns
true if the 'clusterIpv4CidrBlock' attribute was set.

◆ has_cluster_secondary_range_name()

bool google_container_api::IPAllocationPolicy::has_cluster_secondary_range_name ( ) const
inline

Determine if the 'clusterSecondaryRangeName' attribute was set.

Returns
true if the 'clusterSecondaryRangeName' attribute was set.

◆ has_create_subnetwork()

bool google_container_api::IPAllocationPolicy::has_create_subnetwork ( ) const
inline

Determine if the 'createSubnetwork' attribute was set.

Returns
true if the 'createSubnetwork' attribute was set.

◆ has_node_ipv4_cidr()

bool google_container_api::IPAllocationPolicy::has_node_ipv4_cidr ( ) const
inline

Determine if the 'nodeIpv4Cidr' attribute was set.

Returns
true if the 'nodeIpv4Cidr' attribute was set.

◆ has_node_ipv4_cidr_block()

bool google_container_api::IPAllocationPolicy::has_node_ipv4_cidr_block ( ) const
inline

Determine if the 'nodeIpv4CidrBlock' attribute was set.

Returns
true if the 'nodeIpv4CidrBlock' attribute was set.

◆ has_services_ipv4_cidr()

bool google_container_api::IPAllocationPolicy::has_services_ipv4_cidr ( ) const
inline

Determine if the 'servicesIpv4Cidr' attribute was set.

Returns
true if the 'servicesIpv4Cidr' attribute was set.

◆ has_services_ipv4_cidr_block()

bool google_container_api::IPAllocationPolicy::has_services_ipv4_cidr_block ( ) const
inline

Determine if the 'servicesIpv4CidrBlock' attribute was set.

Returns
true if the 'servicesIpv4CidrBlock' attribute was set.

◆ has_services_secondary_range_name()

bool google_container_api::IPAllocationPolicy::has_services_secondary_range_name ( ) const
inline

Determine if the 'servicesSecondaryRangeName' attribute was set.

Returns
true if the 'servicesSecondaryRangeName' attribute was set.

◆ has_subnetwork_name()

bool google_container_api::IPAllocationPolicy::has_subnetwork_name ( ) const
inline

Determine if the 'subnetworkName' attribute was set.

Returns
true if the 'subnetworkName' attribute was set.

◆ has_tpu_ipv4_cidr_block()

bool google_container_api::IPAllocationPolicy::has_tpu_ipv4_cidr_block ( ) const
inline

Determine if the 'tpuIpv4CidrBlock' attribute was set.

Returns
true if the 'tpuIpv4CidrBlock' attribute was set.

◆ has_use_ip_aliases()

bool google_container_api::IPAllocationPolicy::has_use_ip_aliases ( ) const
inline

Determine if the 'useIpAliases' attribute was set.

Returns
true if the 'useIpAliases' attribute was set.

◆ New()

IPAllocationPolicy * google_container_api::IPAllocationPolicy::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_cluster_ipv4_cidr()

void google_container_api::IPAllocationPolicy::set_cluster_ipv4_cidr ( const StringPiece &  value)
inline

Change the 'clusterIpv4Cidr' attribute.

This field is deprecated, use cluster_ipv4_cidr_block.

Parameters
[in]valueThe new value.

◆ set_cluster_ipv4_cidr_block()

void google_container_api::IPAllocationPolicy::set_cluster_ipv4_cidr_block ( const StringPiece &  value)
inline

Change the 'clusterIpv4CidrBlock' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_cluster_secondary_range_name()

void google_container_api::IPAllocationPolicy::set_cluster_secondary_range_name ( const StringPiece &  value)
inline

Change the 'clusterSecondaryRangeName' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_create_subnetwork()

void google_container_api::IPAllocationPolicy::set_create_subnetwork ( bool  value)
inline

Change the 'createSubnetwork' attribute.

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

This field is only applicable when use_ip_aliases is true.

Parameters
[in]valueThe new value.

◆ set_node_ipv4_cidr()

void google_container_api::IPAllocationPolicy::set_node_ipv4_cidr ( const StringPiece &  value)
inline

Change the 'nodeIpv4Cidr' attribute.

This field is deprecated, use node_ipv4_cidr_block.

Parameters
[in]valueThe new value.

◆ set_node_ipv4_cidr_block()

void google_container_api::IPAllocationPolicy::set_node_ipv4_cidr_block ( const StringPiece &  value)
inline

Change the 'nodeIpv4CidrBlock' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_services_ipv4_cidr()

void google_container_api::IPAllocationPolicy::set_services_ipv4_cidr ( const StringPiece &  value)
inline

Change the 'servicesIpv4Cidr' attribute.

This field is deprecated, use services_ipv4_cidr_block.

Parameters
[in]valueThe new value.

◆ set_services_ipv4_cidr_block()

void google_container_api::IPAllocationPolicy::set_services_ipv4_cidr_block ( const StringPiece &  value)
inline

Change the 'servicesIpv4CidrBlock' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_services_secondary_range_name()

void google_container_api::IPAllocationPolicy::set_services_secondary_range_name ( const StringPiece &  value)
inline

Change the 'servicesSecondaryRangeName' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_subnetwork_name()

void google_container_api::IPAllocationPolicy::set_subnetwork_name ( const StringPiece &  value)
inline

Change the 'subnetworkName' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_tpu_ipv4_cidr_block()

void google_container_api::IPAllocationPolicy::set_tpu_ipv4_cidr_block ( const StringPiece &  value)
inline

Change the 'tpuIpv4CidrBlock' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_use_ip_aliases()

void google_container_api::IPAllocationPolicy::set_use_ip_aliases ( bool  value)
inline

Change the 'useIpAliases' attribute.

Whether alias IPs will be used for pod IPs in the cluster.

Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: