Class protos.google.iam.credentials.v1.GenerateAccessTokenResponse

Represents a GenerateAccessTokenResponse.

Package

@google-cloud/iam-credentials!

Constructors

(constructor)(properties)

constructor(properties?: google.iam.credentials.v1.IGenerateAccessTokenResponse);

Constructs a new GenerateAccessTokenResponse.

Parameter
Type Name Description
IGenerateAccessTokenResponse properties

Properties to set

Properties

accessToken

public accessToken: string;

GenerateAccessTokenResponse accessToken.

Property Value
Type Description
string

expireTime

public expireTime?: (google.protobuf.ITimestamp|null);

GenerateAccessTokenResponse expireTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

Methods

create(properties)

public static create(properties?: google.iam.credentials.v1.IGenerateAccessTokenResponse): google.iam.credentials.v1.GenerateAccessTokenResponse;

Creates a new GenerateAccessTokenResponse instance using the specified properties.

Parameter
Type Name Description
IGenerateAccessTokenResponse properties

Properties to set
Returns
Type Description
google.iam.credentials.v1.GenerateAccessTokenResponse

GenerateAccessTokenResponse instance

decode(reader, length)

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

Decodes a GenerateAccessTokenResponse message from the specified reader or buffer.

Parameters
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
number length

Message length if known beforehand
Returns
Type Description
google.iam.credentials.v1.GenerateAccessTokenResponse

GenerateAccessTokenResponse

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.iam.credentials.v1.GenerateAccessTokenResponse;

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

Parameter
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
Returns
Type Description
google.iam.credentials.v1.GenerateAccessTokenResponse

GenerateAccessTokenResponse

encode(message, writer)

public static encode(message: google.iam.credentials.v1.IGenerateAccessTokenResponse, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GenerateAccessTokenResponse message. Does not implicitly messages.

Parameters
Type Name Description
IGenerateAccessTokenResponse message

GenerateAccessTokenResponse message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.iam.credentials.v1.IGenerateAccessTokenResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Type Name Description
IGenerateAccessTokenResponse message

GenerateAccessTokenResponse message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.iam.credentials.v1.GenerateAccessTokenResponse;

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

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

Plain object
Returns
Type Description
google.iam.credentials.v1.GenerateAccessTokenResponse

GenerateAccessTokenResponse

toJSON()

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

Converts this GenerateAccessTokenResponse to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Type Name Description
google.iam.credentials.v1.GenerateAccessTokenResponse message

GenerateAccessTokenResponse
$protobuf.IConversionOptions options

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

Plain object

verify(message)

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

Verifies a GenerateAccessTokenResponse message.

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

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not