Class MasterAuth (2.56.0)

public final class MasterAuth extends GeneratedMessageV3 implements MasterAuthOrBuilder

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

Protobuf type google.container.v1.MasterAuth

Implements

MasterAuthOrBuilder

Static Fields

CLIENT_CERTIFICATE_CONFIG_FIELD_NUMBER

public static final int CLIENT_CERTIFICATE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_CERTIFICATE_FIELD_NUMBER

public static final int CLIENT_CERTIFICATE_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_KEY_FIELD_NUMBER

public static final int CLIENT_KEY_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_CA_CERTIFICATE_FIELD_NUMBER

public static final int CLUSTER_CA_CERTIFICATE_FIELD_NUMBER
Field Value
Type Description
int

PASSWORD_FIELD_NUMBER

public static final int PASSWORD_FIELD_NUMBER
Field Value
Type Description
int

USERNAME_FIELD_NUMBER

public static final int USERNAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MasterAuth getDefaultInstance()
Returns
Type Description
MasterAuth

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MasterAuth.Builder newBuilder()
Returns
Type Description
MasterAuth.Builder

newBuilder(MasterAuth prototype)

public static MasterAuth.Builder newBuilder(MasterAuth prototype)
Parameter
Name Description
prototype MasterAuth
Returns
Type Description
MasterAuth.Builder

parseDelimitedFrom(InputStream input)

public static MasterAuth parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MasterAuth
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MasterAuth parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MasterAuth
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MasterAuth parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MasterAuth
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MasterAuth parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MasterAuth
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MasterAuth parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MasterAuth
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MasterAuth parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MasterAuth
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MasterAuth parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MasterAuth
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MasterAuth parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MasterAuth
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MasterAuth parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MasterAuth
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MasterAuth parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MasterAuth
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MasterAuth parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MasterAuth
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MasterAuth parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MasterAuth
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MasterAuth> parser()
Returns
Type Description
Parser<MasterAuth>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClientCertificate()

public String getClientCertificate()

Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.

string client_certificate = 101 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The clientCertificate.

getClientCertificateBytes()

public ByteString getClientCertificateBytes()

Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.

string client_certificate = 101 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for clientCertificate.

getClientCertificateConfig()

public ClientCertificateConfig getClientCertificateConfig()

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

.google.container.v1.ClientCertificateConfig client_certificate_config = 3;

Returns
Type Description
ClientCertificateConfig

The clientCertificateConfig.

getClientCertificateConfigOrBuilder()

public ClientCertificateConfigOrBuilder getClientCertificateConfigOrBuilder()

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

.google.container.v1.ClientCertificateConfig client_certificate_config = 3;

Returns
Type Description
ClientCertificateConfigOrBuilder

getClientKey()

public String getClientKey()

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

string client_key = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The clientKey.

getClientKeyBytes()

public ByteString getClientKeyBytes()

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

string client_key = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for clientKey.

getClusterCaCertificate()

public String getClusterCaCertificate()

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

string cluster_ca_certificate = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The clusterCaCertificate.

getClusterCaCertificateBytes()

public ByteString getClusterCaCertificateBytes()

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

string cluster_ca_certificate = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for clusterCaCertificate.

getDefaultInstanceForType()

public MasterAuth getDefaultInstanceForType()
Returns
Type Description
MasterAuth

getParserForType()

public Parser<MasterAuth> getParserForType()
Returns
Type Description
Parser<MasterAuth>
Overrides

getPassword() (deprecated)

public String getPassword()

Deprecated. google.container.v1.MasterAuth.password is deprecated. See google/container/v1/cluster_service.proto;l=1264

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

string password = 2 [deprecated = true];

Returns
Type Description
String

The password.

getPasswordBytes() (deprecated)

public ByteString getPasswordBytes()

Deprecated. google.container.v1.MasterAuth.password is deprecated. See google/container/v1/cluster_service.proto;l=1264

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

string password = 2 [deprecated = true];

Returns
Type Description
ByteString

The bytes for password.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUsername() (deprecated)

public String getUsername()

Deprecated. google.container.v1.MasterAuth.username is deprecated. See google/container/v1/cluster_service.proto;l=1253

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

string username = 1 [deprecated = true];

Returns
Type Description
String

The username.

getUsernameBytes() (deprecated)

public ByteString getUsernameBytes()

Deprecated. google.container.v1.MasterAuth.username is deprecated. See google/container/v1/cluster_service.proto;l=1253

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

string username = 1 [deprecated = true];

Returns
Type Description
ByteString

The bytes for username.

hasClientCertificateConfig()

public boolean hasClientCertificateConfig()

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

.google.container.v1.ClientCertificateConfig client_certificate_config = 3;

Returns
Type Description
boolean

Whether the clientCertificateConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MasterAuth.Builder newBuilderForType()
Returns
Type Description
MasterAuth.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MasterAuth.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MasterAuth.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MasterAuth.Builder toBuilder()
Returns
Type Description
MasterAuth.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException