container  v1
Public Member Functions | Static Public Member Functions | List of all members
google_container_api::MasterAuth Class Reference

#include <master_auth.h>

Inheritance diagram for google_container_api::MasterAuth:

Public Member Functions

 MasterAuth (const Json::Value &storage)
 
 MasterAuth (Json::Value *storage)
 
virtual ~MasterAuth ()
 
const StringPiece GetTypeName () const
 
bool has_client_certificate () const
 
void clear_client_certificate ()
 
const StringPiece get_client_certificate () const
 
void set_client_certificate (const StringPiece &value)
 
bool has_client_certificate_config () const
 
void clear_client_certificate_config ()
 
const ClientCertificateConfig get_client_certificate_config () const
 
ClientCertificateConfig mutable_clientCertificateConfig ()
 
bool has_client_key () const
 
void clear_client_key ()
 
const StringPiece get_client_key () const
 
void set_client_key (const StringPiece &value)
 
bool has_cluster_ca_certificate () const
 
void clear_cluster_ca_certificate ()
 
const StringPiece get_cluster_ca_certificate () const
 
void set_cluster_ca_certificate (const StringPiece &value)
 
bool has_password () const
 
void clear_password ()
 
const StringPiece get_password () const
 
void set_password (const StringPiece &value)
 
bool has_username () const
 
void clear_username ()
 
const StringPiece get_username () const
 
void set_username (const StringPiece &value)
 

Static Public Member Functions

static MasterAuthNew ()
 

Detailed Description

The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.

Constructor & Destructor Documentation

◆ MasterAuth() [1/2]

google_container_api::MasterAuth::MasterAuth ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ MasterAuth() [2/2]

google_container_api::MasterAuth::MasterAuth ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~MasterAuth()

google_container_api::MasterAuth::~MasterAuth ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_client_certificate()

void google_container_api::MasterAuth::clear_client_certificate ( )
inline

Clears the 'clientCertificate' attribute.

◆ clear_client_certificate_config()

void google_container_api::MasterAuth::clear_client_certificate_config ( )
inline

Clears the 'clientCertificateConfig' attribute.

◆ clear_client_key()

void google_container_api::MasterAuth::clear_client_key ( )
inline

Clears the 'clientKey' attribute.

◆ clear_cluster_ca_certificate()

void google_container_api::MasterAuth::clear_cluster_ca_certificate ( )
inline

Clears the 'clusterCaCertificate' attribute.

◆ clear_password()

void google_container_api::MasterAuth::clear_password ( )
inline

Clears the 'password' attribute.

◆ clear_username()

void google_container_api::MasterAuth::clear_username ( )
inline

Clears the 'username' attribute.

◆ get_client_certificate()

const StringPiece google_container_api::MasterAuth::get_client_certificate ( ) const
inline

Get the value of the 'clientCertificate' attribute.

◆ get_client_certificate_config()

const ClientCertificateConfig google_container_api::MasterAuth::get_client_certificate_config ( ) const

Get a reference to the value of the 'clientCertificateConfig' attribute.

◆ get_client_key()

const StringPiece google_container_api::MasterAuth::get_client_key ( ) const
inline

Get the value of the 'clientKey' attribute.

◆ get_cluster_ca_certificate()

const StringPiece google_container_api::MasterAuth::get_cluster_ca_certificate ( ) const
inline

Get the value of the 'clusterCaCertificate' attribute.

◆ get_password()

const StringPiece google_container_api::MasterAuth::get_password ( ) const
inline

Get the value of the 'password' attribute.

◆ get_username()

const StringPiece google_container_api::MasterAuth::get_username ( ) const
inline

Get the value of the 'username' attribute.

◆ GetTypeName()

const StringPiece google_container_api::MasterAuth::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_container_api::MasterAuth

◆ has_client_certificate()

bool google_container_api::MasterAuth::has_client_certificate ( ) const
inline

Determine if the 'clientCertificate' attribute was set.

Returns
true if the 'clientCertificate' attribute was set.

◆ has_client_certificate_config()

bool google_container_api::MasterAuth::has_client_certificate_config ( ) const
inline

Determine if the 'clientCertificateConfig' attribute was set.

Returns
true if the 'clientCertificateConfig' attribute was set.

◆ has_client_key()

bool google_container_api::MasterAuth::has_client_key ( ) const
inline

Determine if the 'clientKey' attribute was set.

Returns
true if the 'clientKey' attribute was set.

◆ has_cluster_ca_certificate()

bool google_container_api::MasterAuth::has_cluster_ca_certificate ( ) const
inline

Determine if the 'clusterCaCertificate' attribute was set.

Returns
true if the 'clusterCaCertificate' attribute was set.

◆ has_password()

bool google_container_api::MasterAuth::has_password ( ) const
inline

Determine if the 'password' attribute was set.

Returns
true if the 'password' attribute was set.

◆ has_username()

bool google_container_api::MasterAuth::has_username ( ) const
inline

Determine if the 'username' attribute was set.

Returns
true if the 'username' attribute was set.

◆ mutable_clientCertificateConfig()

ClientCertificateConfig google_container_api::MasterAuth::mutable_clientCertificateConfig ( )

Gets a reference to a mutable value of the 'clientCertificateConfig' property.

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

Returns
The result can be modified to change the attribute value.

◆ New()

MasterAuth * google_container_api::MasterAuth::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_client_certificate()

void google_container_api::MasterAuth::set_client_certificate ( const StringPiece &  value)
inline

Change the 'clientCertificate' attribute.

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

Parameters
[in]valueThe new value.

◆ set_client_key()

void google_container_api::MasterAuth::set_client_key ( const StringPiece &  value)
inline

Change the 'clientKey' attribute.

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

Parameters
[in]valueThe new value.

◆ set_cluster_ca_certificate()

void google_container_api::MasterAuth::set_cluster_ca_certificate ( const StringPiece &  value)
inline

Change the 'clusterCaCertificate' attribute.

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

Parameters
[in]valueThe new value.

◆ set_password()

void google_container_api::MasterAuth::set_password ( const StringPiece &  value)
inline

Change the 'password' attribute.

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.

Parameters
[in]valueThe new value.

◆ set_username()

void google_container_api::MasterAuth::set_username ( const StringPiece &  value)
inline

Change the 'username' attribute.

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).

Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: