Google Cloud Container V1 Client - Class PrivateClusterConfig (1.24.0)

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

Namespace

Google \ Cloud \ Container \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this

getEnablePrivateEndpoint

Whether the master's internal IP address is used as the cluster endpoint.

Returns
TypeDescription
bool

setEnablePrivateEndpoint

Whether the master's internal IP address is used as the cluster endpoint.

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getPrivateEndpoint

Output only. The internal IP address of this cluster's master endpoint.

Returns
TypeDescription
string

setPrivateEndpoint

Output only. The internal IP address of this cluster's master endpoint.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPublicEndpoint

Output only. The external IP address of this cluster's master endpoint.

Returns
TypeDescription
string

setPublicEndpoint

Output only. The external IP address of this cluster's master endpoint.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPeeringName

Output only. The peering name in the customer VPC used by this cluster.

Returns
TypeDescription
string

setPeeringName

Output only. The peering name in the customer VPC used by this cluster.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMasterGlobalAccessConfig

Controls master global access settings.

Returns
TypeDescription
Google\Cloud\Container\V1\PrivateClusterMasterGlobalAccessConfig|null

hasMasterGlobalAccessConfig

clearMasterGlobalAccessConfig

setMasterGlobalAccessConfig

Controls master global access settings.

Parameter
NameDescription
var Google\Cloud\Container\V1\PrivateClusterMasterGlobalAccessConfig
Returns
TypeDescription
$this

getPrivateEndpointSubnetwork

Subnet to provision the master's private endpoint during cluster creation.

Specified in projects//regions//subnetworks/* format.

Returns
TypeDescription
string

setPrivateEndpointSubnetwork

Subnet to provision the master's private endpoint during cluster creation.

Specified in projects//regions//subnetworks/* format.

Parameter
NameDescription
var string
Returns
TypeDescription
$this