Google Cloud Container V1 Client - Class MasterAuth (1.10.3)

Reference documentation and code samples for the Google Cloud Container V1 Client class MasterAuth.

The authentication information for accessing the master endpoint.

Authentication can be done using HTTP basic auth or using client certificates.

Generated from protobuf message google.container.v1.MasterAuth

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ username string

The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

↳ password string

The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

↳ client_certificate_config Google\Cloud\Container\V1\ClientCertificateConfig

Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.

↳ cluster_ca_certificate string

[Output only] Base64-encoded public certificate that is the root of trust for the cluster.

↳ client_certificate string

[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

↳ client_key string

[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

getUsername

The username to use for HTTP basic authentication to the master endpoint.

For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

Returns
TypeDescription
string

setUsername

The username to use for HTTP basic authentication to the master endpoint.

For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPassword

The password to use for HTTP basic authentication to the master endpoint.

Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

Returns
TypeDescription
string

setPassword

The password to use for HTTP basic authentication to the master endpoint.

Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClientCertificateConfig

Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.

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

hasClientCertificateConfig

clearClientCertificateConfig

setClientCertificateConfig

Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.

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

getClusterCaCertificate

[Output only] Base64-encoded public certificate that is the root of trust for the cluster.

Returns
TypeDescription
string

setClusterCaCertificate

[Output only] Base64-encoded public certificate that is the root of trust for the cluster.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClientCertificate

[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

Returns
TypeDescription
string

setClientCertificate

[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClientKey

[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

Returns
TypeDescription
string

setClientKey

[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

Parameter
NameDescription
var string
Returns
TypeDescription
$this