Class protos.google.cloud.gkeconnect.gateway.v1beta1.GenerateCredentialsRequest (4.0.0)

Represents a GenerateCredentialsRequest.

Package

@google-cloud/gke-connect-gateway

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest);

Constructs a new GenerateCredentialsRequest.

Parameter
Name Description
properties IGenerateCredentialsRequest

Properties to set

Properties

forceUseAgent

public forceUseAgent: boolean;

GenerateCredentialsRequest forceUseAgent.

kubernetesNamespace

public kubernetesNamespace: string;

GenerateCredentialsRequest kubernetesNamespace.

name

public name: string;

GenerateCredentialsRequest name.

operatingSystem

public operatingSystem: (google.cloud.gkeconnect.gateway.v1beta1.GenerateCredentialsRequest.OperatingSystem|keyof typeof google.cloud.gkeconnect.gateway.v1beta1.GenerateCredentialsRequest.OperatingSystem);

GenerateCredentialsRequest operatingSystem.

version

public version: string;

GenerateCredentialsRequest version.

Methods

create(properties)

public static create(properties?: google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest): google.cloud.gkeconnect.gateway.v1beta1.GenerateCredentialsRequest;

Creates a new GenerateCredentialsRequest instance using the specified properties.

Parameter
Name Description
properties IGenerateCredentialsRequest

Properties to set

Returns
Type Description
GenerateCredentialsRequest

GenerateCredentialsRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.gkeconnect.gateway.v1beta1.GenerateCredentialsRequest;

Decodes a GenerateCredentialsRequest 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
GenerateCredentialsRequest

GenerateCredentialsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gkeconnect.gateway.v1beta1.GenerateCredentialsRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
GenerateCredentialsRequest

GenerateCredentialsRequest

encode(message, writer)

public static encode(message: google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GenerateCredentialsRequest message. Does not implicitly messages.

Parameters
Name Description
message IGenerateCredentialsRequest

GenerateCredentialsRequest 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.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IGenerateCredentialsRequest

GenerateCredentialsRequest 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.cloud.gkeconnect.gateway.v1beta1.GenerateCredentialsRequest;

Creates a GenerateCredentialsRequest 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
GenerateCredentialsRequest

GenerateCredentialsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for GenerateCredentialsRequest

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 GenerateCredentialsRequest to JSON.

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

JSON object

toObject(message, options)

public static toObject(message: google.cloud.gkeconnect.gateway.v1beta1.GenerateCredentialsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message GenerateCredentialsRequest

GenerateCredentialsRequest

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 GenerateCredentialsRequest 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