Class protos.google.cloud.gkemulticloud.v1.GenerateAwsClusterAgentTokenRequest (1.1.0)

Represents a GenerateAwsClusterAgentTokenRequest.

Package

@google-cloud/gkemulticloud

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest);

Constructs a new GenerateAwsClusterAgentTokenRequest.

Parameter
NameDescription
properties IGenerateAwsClusterAgentTokenRequest

Properties to set

Properties

audience

public audience: string;

GenerateAwsClusterAgentTokenRequest audience.

awsCluster

public awsCluster: string;

GenerateAwsClusterAgentTokenRequest awsCluster.

grantType

public grantType: string;

GenerateAwsClusterAgentTokenRequest grantType.

nodePoolId

public nodePoolId: string;

GenerateAwsClusterAgentTokenRequest nodePoolId.

options

public options: string;

GenerateAwsClusterAgentTokenRequest options.

requestedTokenType

public requestedTokenType: string;

GenerateAwsClusterAgentTokenRequest requestedTokenType.

scope

public scope: string;

GenerateAwsClusterAgentTokenRequest scope.

subjectToken

public subjectToken: string;

GenerateAwsClusterAgentTokenRequest subjectToken.

subjectTokenType

public subjectTokenType: string;

GenerateAwsClusterAgentTokenRequest subjectTokenType.

version

public version: string;

GenerateAwsClusterAgentTokenRequest version.

Methods

create(properties)

public static create(properties?: google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest): google.cloud.gkemulticloud.v1.GenerateAwsClusterAgentTokenRequest;

Creates a new GenerateAwsClusterAgentTokenRequest instance using the specified properties.

Parameter
NameDescription
properties IGenerateAwsClusterAgentTokenRequest

Properties to set

Returns
TypeDescription
GenerateAwsClusterAgentTokenRequest

GenerateAwsClusterAgentTokenRequest instance

decode(reader, length)

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

Decodes a GenerateAwsClusterAgentTokenRequest message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
GenerateAwsClusterAgentTokenRequest

GenerateAwsClusterAgentTokenRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gkemulticloud.v1.GenerateAwsClusterAgentTokenRequest;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
GenerateAwsClusterAgentTokenRequest

GenerateAwsClusterAgentTokenRequest

encode(message, writer)

public static encode(message: google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GenerateAwsClusterAgentTokenRequest message. Does not implicitly messages.

Parameters
NameDescription
message IGenerateAwsClusterAgentTokenRequest

GenerateAwsClusterAgentTokenRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IGenerateAwsClusterAgentTokenRequest

GenerateAwsClusterAgentTokenRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.gkemulticloud.v1.GenerateAwsClusterAgentTokenRequest;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
GenerateAwsClusterAgentTokenRequest

GenerateAwsClusterAgentTokenRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for GenerateAwsClusterAgentTokenRequest

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this GenerateAwsClusterAgentTokenRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message GenerateAwsClusterAgentTokenRequest

GenerateAwsClusterAgentTokenRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a GenerateAwsClusterAgentTokenRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not