Reference documentation and code samples for the Google Cloud Container V1 Client class PrivateClusterConfig.
Configuration options for private clusters.
Generated from protobuf message google.container.v1.PrivateClusterConfig
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ enable_private_nodes |
bool
Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking. |
↳ enable_private_endpoint |
bool
Whether the master's internal IP address is used as the cluster endpoint. |
↳ master_ipv4_cidr_block |
string
The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network. |
↳ private_endpoint |
string
Output only. The internal IP address of this cluster's master endpoint. |
↳ public_endpoint |
string
Output only. The external IP address of this cluster's master endpoint. |
↳ peering_name |
string
Output only. The peering name in the customer VPC used by this cluster. |
↳ master_global_access_config |
Google\Cloud\Container\V1\PrivateClusterMasterGlobalAccessConfig
Controls master global access settings. |
↳ private_endpoint_subnetwork |
string
Subnet to provision the master's private endpoint during cluster creation. Specified in projects//regions//subnetworks/* format. |
getEnablePrivateNodes
Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnablePrivateNodes
Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnablePrivateEndpoint
Whether the master's internal IP address is used as the cluster endpoint.
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnablePrivateEndpoint
Whether the master's internal IP address is used as the cluster endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMasterIpv4CidrBlock
The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.
| Returns | |
|---|---|
| Type | Description |
string | |
setMasterIpv4CidrBlock
The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrivateEndpoint
Output only. The internal IP address of this cluster's master endpoint.
| Returns | |
|---|---|
| Type | Description |
string | |
setPrivateEndpoint
Output only. The internal IP address of this cluster's master endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPublicEndpoint
Output only. The external IP address of this cluster's master endpoint.
| Returns | |
|---|---|
| Type | Description |
string | |
setPublicEndpoint
Output only. The external IP address of this cluster's master endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPeeringName
Output only. The peering name in the customer VPC used by this cluster.
| Returns | |
|---|---|
| Type | Description |
string | |
setPeeringName
Output only. The peering name in the customer VPC used by this cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMasterGlobalAccessConfig
Controls master global access settings.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\PrivateClusterMasterGlobalAccessConfig|null | |
hasMasterGlobalAccessConfig
clearMasterGlobalAccessConfig
setMasterGlobalAccessConfig
Controls master global access settings.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\PrivateClusterMasterGlobalAccessConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrivateEndpointSubnetwork
Subnet to provision the master's private endpoint during cluster creation.
Specified in projects//regions//subnetworks/* format.
| Returns | |
|---|---|
| Type | Description |
string | |
setPrivateEndpointSubnetwork
Subnet to provision the master's private endpoint during cluster creation.
Specified in projects//regions//subnetworks/* format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |