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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ subnetwork_name |
string
A custom subnetwork name to be used if |
↳ 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 |
↳ node_ipv4_cidr_block |
string
The IP address range of the instance IPs in this cluster. This is applicable only if |
↳ 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 |
↳ 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_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 |
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
Generated from protobuf field bool use_ip_aliases = 1;
| Returns | |
|---|---|
| Type | Description |
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
Generated from protobuf field bool use_ip_aliases = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateSubnetwork
Whether a new subnetwork will be created automatically for the cluster.
This field is only applicable when use_ip_aliases is true.
Generated from protobuf field bool create_subnetwork = 2;
| Returns | |
|---|---|
| Type | Description |
bool | |
setCreateSubnetwork
Whether a new subnetwork will be created automatically for the cluster.
This field is only applicable when use_ip_aliases is true.
Generated from protobuf field bool create_subnetwork = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string subnetwork_name = 3;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string subnetwork_name = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClusterIpv4Cidr
This field is deprecated, use cluster_ipv4_cidr_block.
Generated from protobuf field string cluster_ipv4_cidr = 4 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
string | |
setClusterIpv4Cidr
This field is deprecated, use cluster_ipv4_cidr_block.
Generated from protobuf field string cluster_ipv4_cidr = 4 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNodeIpv4Cidr
This field is deprecated, use node_ipv4_cidr_block.
Generated from protobuf field string node_ipv4_cidr = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
string | |
setNodeIpv4Cidr
This field is deprecated, use node_ipv4_cidr_block.
Generated from protobuf field string node_ipv4_cidr = 5 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServicesIpv4Cidr
This field is deprecated, use services_ipv4_cidr_block.
Generated from protobuf field string services_ipv4_cidr = 6 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
string | |
setServicesIpv4Cidr
This field is deprecated, use services_ipv4_cidr_block.
Generated from protobuf field string services_ipv4_cidr = 6 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string cluster_secondary_range_name = 7;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string cluster_secondary_range_name = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string services_secondary_range_name = 8;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string services_secondary_range_name = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string cluster_ipv4_cidr_block = 9;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string cluster_ipv4_cidr_block = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string node_ipv4_cidr_block = 10;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string node_ipv4_cidr_block = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string services_ipv4_cidr_block = 11;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string services_ipv4_cidr_block = 11;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string tpu_ipv4_cidr_block = 13;
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string tpu_ipv4_cidr_block = 13;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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
Generated from protobuf field bool use_routes = 15;
| Returns | |
|---|---|
| Type | Description |
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
Generated from protobuf field bool use_routes = 15;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStackType
The IP stack type of the cluster
Generated from protobuf field .google.container.v1.StackType stack_type = 16;
| Returns | |
|---|---|
| Type | Description |
int | |
setStackType
The IP stack type of the cluster
Generated from protobuf field .google.container.v1.StackType stack_type = 16;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIpv6AccessType
The ipv6 access type (internal or external) when create_subnetwork is true
Generated from protobuf field .google.container.v1.IPv6AccessType ipv6_access_type = 17;
| Returns | |
|---|---|
| Type | Description |
int | |
setIpv6AccessType
The ipv6 access type (internal or external) when create_subnetwork is true
Generated from protobuf field .google.container.v1.IPv6AccessType ipv6_access_type = 17;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |