Reference documentation and code samples for the Google Cloud Container V1 Client class IPAllocationPolicy.
Configuration for controlling how IPs are allocated in the cluster.
Generated from protobuf message google.container.v1.IPAllocationPolicy
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ use_ip_aliases
bool
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
↳ create_subnetwork
bool
Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when use_ip_aliases
is true.
↳ subnetwork_name
string
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.
↳ cluster_ipv4_cidr
string
This field is deprecated, use cluster_ipv4_cidr_block.
↳ node_ipv4_cidr
string
This field is deprecated, use node_ipv4_cidr_block.
↳ services_ipv4_cidr
string
This field is deprecated, use services_ipv4_cidr_block.
↳ cluster_secondary_range_name
string
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.
↳ services_secondary_range_name
string
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.
↳ cluster_ipv4_cidr_block
string
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.
↳ node_ipv4_cidr_block
string
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.
↳ services_ipv4_cidr_block
string
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.
↳ tpu_ipv4_cidr_block
string
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.
↳ use_routes
bool
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
↳ stack_type
int
The IP stack type of the cluster
↳ ipv6_access_type
int
The ipv6 access type (internal or external) when create_subnetwork is true
↳ subnet_ipv6_cidr_block
string
Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.
↳ services_ipv6_cidr_block
string
Output only. [Output only] The services IPv6 CIDR block for the cluster.
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
setUseIpAliases
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
var
bool
$this
getCreateSubnetwork
Whether a new subnetwork will be created automatically for the cluster.
This field is only applicable when use_ip_aliases
is true.
bool
setCreateSubnetwork
Whether a new subnetwork will be created automatically for the cluster.
This field is only applicable when use_ip_aliases
is true.
var
bool
$this
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
setSubnetworkName
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.
var
string
$this
getClusterIpv4Cidr
This field is deprecated, use cluster_ipv4_cidr_block.
string
setClusterIpv4Cidr
This field is deprecated, use cluster_ipv4_cidr_block.
var
string
$this
getNodeIpv4Cidr
This field is deprecated, use node_ipv4_cidr_block.
string
setNodeIpv4Cidr
This field is deprecated, use node_ipv4_cidr_block.
var
string
$this
getServicesIpv4Cidr
This field is deprecated, use services_ipv4_cidr_block.
string
setServicesIpv4Cidr
This field is deprecated, use services_ipv4_cidr_block.
var
string
$this
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
setClusterSecondaryRangeName
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.
var
string
$this
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
setServicesSecondaryRangeName
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.
var
string
$this
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
setClusterIpv4CidrBlock
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.
var
string
$this
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
setNodeIpv4CidrBlock
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.
var
string
$this
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
setServicesIpv4CidrBlock
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.
var
string
$this
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
setTpuIpv4CidrBlock
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.
var
string
$this
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
setUseRoutes
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
var
bool
$this
getStackType
The IP stack type of the cluster
int
setStackType
The IP stack type of the cluster
var
int
$this
getIpv6AccessType
The ipv6 access type (internal or external) when create_subnetwork is true
int
setIpv6AccessType
The ipv6 access type (internal or external) when create_subnetwork is true
var
int
$this
getSubnetIpv6CidrBlock
Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.
string
setSubnetIpv6CidrBlock
Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.
var
string
$this
getServicesIpv6CidrBlock
Output only. [Output only] The services IPv6 CIDR block for the cluster.
string
setServicesIpv6CidrBlock
Output only. [Output only] The services IPv6 CIDR block for the cluster.
var
string
$this
