Google Cloud Deploy V1 Client - Class GkeCluster (1.5.0)

Version 1.5.0

• 2.0.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.0
• 0.19.1
• 0.18.1
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.1
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.4

Reference documentation and code samples for the Google Cloud Deploy V1 Client class GkeCluster.

Information specifying a GKE Cluster.

Generated from protobuf message google.cloud.deploy.v1.GkeCluster

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ cluster	string Optional. Information specifying a GKE Cluster. Format is projects/{project_id}/locations/{location_id}/clusters/{cluster_id}.
↳ internal_ip	bool Optional. If true, cluster is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise. Only specify this option when cluster is a private GKE cluster. Note that internal_ip and dns_endpoint cannot both be set to true.
↳ proxy_url	string Optional. If set, used to configure a proxy to the Kubernetes server.
↳ dns_endpoint	bool Optional. If set, the cluster will be accessed using the DNS endpoint. Note that dns_endpoint and internal_ip cannot both be set to true.

getCluster

Optional. Information specifying a GKE Cluster. Format is projects/{project_id}/locations/{location_id}/clusters/{cluster_id}.

Returns
Type	Description
string

setCluster

Optional. Information specifying a GKE Cluster. Format is projects/{project_id}/locations/{location_id}/clusters/{cluster_id}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getInternalIp

Optional. If true, cluster is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise.

Only specify this option when cluster is a private GKE cluster. Note that internal_ip and dns_endpoint cannot both be set to true.

Returns
Type	Description
bool

setInternalIp

Optional. If true, cluster is accessed using the private IP address of the control plane endpoint. Otherwise, the default IP address of the control plane endpoint is used. The default IP address is the private IP address for clusters with private control-plane endpoints and the public IP address otherwise.

Only specify this option when cluster is a private GKE cluster. Note that internal_ip and dns_endpoint cannot both be set to true.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getProxyUrl

Optional. If set, used to configure a proxy to the Kubernetes server.

Returns
Type	Description
string

setProxyUrl

Optional. If set, used to configure a proxy to the Kubernetes server.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDnsEndpoint

Optional. If set, the cluster will be accessed using the DNS endpoint. Note that dns_endpoint and internal_ip cannot both be set to true.

Returns
Type	Description
bool

setDnsEndpoint

Optional. If set, the cluster will be accessed using the DNS endpoint. Note that dns_endpoint and internal_ip cannot both be set to true.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this