Skip to main content

Class: GetApiKeyResponse

Represents a GetApiKeyResponse.

Properties​

apiKey?​

optional apiKey?: $Properties | null

The api key.

Methods​

toJSON()​

toJSON(): object

Converts this GetApiKeyResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): GetApiKeyResponse & $Properties

Creates a new GetApiKeyResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetApiKeyResponse & $Properties

GetApiKeyResponse instance

Call Signature​

static create(properties?): GetApiKeyResponse

Creates a new GetApiKeyResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetApiKeyResponse

GetApiKeyResponse instance

decode()​

static decode(reader, length?): GetApiKeyResponse & $Properties

Decodes a GetApiKeyResponse message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

GetApiKeyResponse & $Properties

GetApiKeyResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): GetApiKeyResponse & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

GetApiKeyResponse & $Properties

GetApiKeyResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified GetApiKeyResponse message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetApiKeyResponse.verify|verify messages.

Parameters​

message​

$Properties

GetApiKeyResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified GetApiKeyResponse message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetApiKeyResponse.verify|verify messages.

Parameters​

message​

$Properties

GetApiKeyResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): GetApiKeyResponse

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

GetApiKeyResponse

GetApiKeyResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

GetApiKeyResponse

GetApiKeyResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object