Class protos.google.iam.credentials.v1.GenerateIdTokenRequest

Represents a GenerateIdTokenRequest.

Package

@google-cloud/iam-credentials

Constructors

(constructor)(properties)

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

Constructs a new GenerateIdTokenRequest.

Parameter
NameDescription
properties IGenerateIdTokenRequest

Properties to set

Properties

audience

public audience: string;

GenerateIdTokenRequest audience.

delegates

public delegates: string[];

GenerateIdTokenRequest delegates.

includeEmail

public includeEmail: boolean;

GenerateIdTokenRequest includeEmail.

name

public name: string;

GenerateIdTokenRequest name.

Methods

create(properties)

public static create(properties?: google.iam.credentials.v1.IGenerateIdTokenRequest): google.iam.credentials.v1.GenerateIdTokenRequest;

Creates a new GenerateIdTokenRequest instance using the specified properties.

Parameter
NameDescription
properties IGenerateIdTokenRequest

Properties to set

Returns
TypeDescription
google.iam.credentials.v1.GenerateIdTokenRequest

GenerateIdTokenRequest instance

decode(reader, length)

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

Decodes a GenerateIdTokenRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.iam.credentials.v1.GenerateIdTokenRequest

GenerateIdTokenRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.iam.credentials.v1.GenerateIdTokenRequest

GenerateIdTokenRequest

encode(message, writer)

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

Encodes the specified GenerateIdTokenRequest message. Does not implicitly messages.

Parameters
NameDescription
message IGenerateIdTokenRequest

GenerateIdTokenRequest 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.iam.credentials.v1.IGenerateIdTokenRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IGenerateIdTokenRequest

GenerateIdTokenRequest 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.iam.credentials.v1.GenerateIdTokenRequest;

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

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

Plain object

Returns
TypeDescription
google.iam.credentials.v1.GenerateIdTokenRequest

GenerateIdTokenRequest

toJSON()

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

Converts this GenerateIdTokenRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.iam.credentials.v1.GenerateIdTokenRequest

GenerateIdTokenRequest

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