Class protos.google.container.v1.MasterAuth (5.19.0)

Represents a MasterAuth.

Package

@google-cloud/container

Constructors

(constructor)(properties)

constructor(properties?: google.container.v1.IMasterAuth);

Constructs a new MasterAuth.

Parameter
Name Description
properties IMasterAuth

Properties to set

Properties

clientCertificate

public clientCertificate: string;

MasterAuth clientCertificate.

clientCertificateConfig

public clientCertificateConfig?: (google.container.v1.IClientCertificateConfig|null);

MasterAuth clientCertificateConfig.

clientKey

public clientKey: string;

MasterAuth clientKey.

clusterCaCertificate

public clusterCaCertificate: string;

MasterAuth clusterCaCertificate.

password

public password: string;

MasterAuth password.

username

public username: string;

MasterAuth username.

Methods

create(properties)

public static create(properties?: google.container.v1.IMasterAuth): google.container.v1.MasterAuth;

Creates a new MasterAuth instance using the specified properties.

Parameter
Name Description
properties IMasterAuth

Properties to set

Returns
Type Description
MasterAuth

MasterAuth instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.container.v1.MasterAuth;

Decodes a MasterAuth message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
MasterAuth

MasterAuth

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.container.v1.MasterAuth;

Decodes a MasterAuth message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
MasterAuth

MasterAuth

encode(message, writer)

public static encode(message: google.container.v1.IMasterAuth, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MasterAuth message. Does not implicitly messages.

Parameters
Name Description
message IMasterAuth

MasterAuth message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.container.v1.IMasterAuth, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MasterAuth message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IMasterAuth

MasterAuth message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.container.v1.MasterAuth;

Creates a MasterAuth message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
MasterAuth

MasterAuth

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for MasterAuth

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this MasterAuth to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.container.v1.MasterAuth, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a MasterAuth message. Also converts values to other types if specified.

Parameters
Name Description
message MasterAuth

MasterAuth

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a MasterAuth message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not