Reference documentation and code samples for the Google Cloud Container V1 Client class IPEndpointsConfig.
IP endpoints configuration.
Generated from protobuf message google.container.v1.ControlPlaneEndpointsConfig.IPEndpointsConfig
Namespace
Google \ Cloud \ Container \ V1 \ ControlPlaneEndpointsConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ enabled |
bool
Controls whether to allow direct IP access. |
↳ enable_public_endpoint |
bool
Controls whether the control plane allows access through a public IP. It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time. |
↳ global_access |
bool
Controls whether the control plane's private endpoint is accessible from sources in other regions. It is invalid to specify both PrivateClusterMasterGlobalAccessConfig.enabled and this field at the same time. |
↳ authorized_networks_config |
Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig
Configuration of authorized networks. If enabled, restricts access to the control plane based on source IP. It is invalid to specify both Cluster.masterAuthorizedNetworksConfig and this field at the same time. |
↳ public_endpoint |
string
Output only. The external IP address of this cluster's control plane. Only populated if enabled. |
↳ private_endpoint |
string
Output only. The internal IP address of this cluster's control plane. Only populated if enabled. |
↳ private_endpoint_subnetwork |
string
Subnet to provision the master's private endpoint during cluster creation. Specified in projects//regions//subnetworks/* format. It is invalid to specify both PrivateClusterConfig.privateEndpointSubnetwork and this field at the same time. |
getEnabled
Controls whether to allow direct IP access.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasEnabled
clearEnabled
setEnabled
Controls whether to allow direct IP access.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnablePublicEndpoint
Controls whether the control plane allows access through a public IP.
It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasEnablePublicEndpoint
clearEnablePublicEndpoint
setEnablePublicEndpoint
Controls whether the control plane allows access through a public IP.
It is invalid to specify both PrivateClusterConfig.enablePrivateEndpoint and this field at the same time.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGlobalAccess
Controls whether the control plane's private endpoint is accessible from sources in other regions.
It is invalid to specify both PrivateClusterMasterGlobalAccessConfig.enabled and this field at the same time.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasGlobalAccess
clearGlobalAccess
setGlobalAccess
Controls whether the control plane's private endpoint is accessible from sources in other regions.
It is invalid to specify both PrivateClusterMasterGlobalAccessConfig.enabled and this field at the same time.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAuthorizedNetworksConfig
Configuration of authorized networks. If enabled, restricts access to the control plane based on source IP.
It is invalid to specify both Cluster.masterAuthorizedNetworksConfig and this field at the same time.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig|null |
|
hasAuthorizedNetworksConfig
clearAuthorizedNetworksConfig
setAuthorizedNetworksConfig
Configuration of authorized networks. If enabled, restricts access to the control plane based on source IP.
It is invalid to specify both Cluster.masterAuthorizedNetworksConfig and this field at the same time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPublicEndpoint
Output only. The external IP address of this cluster's control plane.
Only populated if enabled.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPublicEndpoint
Output only. The external IP address of this cluster's control plane.
Only populated if enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrivateEndpoint
Output only. The internal IP address of this cluster's control plane.
Only populated if enabled.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPrivateEndpoint
Output only. The internal IP address of this cluster's control plane.
Only populated if enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrivateEndpointSubnetwork
Subnet to provision the master's private endpoint during cluster creation. Specified in projects//regions//subnetworks/* format. It is invalid to specify both PrivateClusterConfig.privateEndpointSubnetwork and this field at the same time.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPrivateEndpointSubnetwork
Subnet to provision the master's private endpoint during cluster creation. Specified in projects//regions//subnetworks/* format. It is invalid to specify both PrivateClusterConfig.privateEndpointSubnetwork and this field at the same time.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|