Class protos.google.cloud.tasks.v2beta3.OidcToken (2.3.6)

Represents an OidcToken.

Package

@google-cloud/tasks!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.tasks.v2beta3.IOidcToken);

Constructs a new OidcToken.

Parameter
Name Description
properties IOidcToken

Properties to set

Properties

audience

public audience: string;

OidcToken audience.

Property Value
Type Description
string

serviceAccountEmail

public serviceAccountEmail: string;

OidcToken serviceAccountEmail.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.cloud.tasks.v2beta3.IOidcToken): google.cloud.tasks.v2beta3.OidcToken;

Creates a new OidcToken instance using the specified properties.

Parameter
Name Description
properties IOidcToken

Properties to set
Returns
Type Description
google.cloud.tasks.v2beta3.OidcToken

OidcToken instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tasks.v2beta3.OidcToken;

Decodes an OidcToken message from the specified reader or buffer.

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

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.tasks.v2beta3.OidcToken

OidcToken

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tasks.v2beta3.OidcToken;

Decodes an OidcToken message from the specified reader or buffer, length delimited.

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

Reader or buffer to decode from
Returns
Type Description
google.cloud.tasks.v2beta3.OidcToken

OidcToken

encode(message, writer)

public static encode(message: google.cloud.tasks.v2beta3.IOidcToken, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified OidcToken message. Does not implicitly messages.

Parameters
Name Description
message IOidcToken

OidcToken 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.tasks.v2beta3.IOidcToken, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IOidcToken

OidcToken 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.tasks.v2beta3.OidcToken;

Creates an OidcToken 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
google.cloud.tasks.v2beta3.OidcToken

OidcToken

toJSON()

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

Converts this OidcToken to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.tasks.v2beta3.OidcToken

OidcToken
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 an OidcToken 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