Skip to main content

Class: CreateApiKeyResponse

Represents a CreateApiKeyResponse.

Properties​

asyncOperation?​

optional asyncOperation?: $Properties | null

The async operation.

keyId​

keyId: string

The id of the api key created.

token​

token: string

The token of the api key created. This is a secret and should be stored securely. It will not be retrievable after this response.

Methods​

toJSON()​

toJSON(): object

Converts this CreateApiKeyResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CreateApiKeyResponse & $Properties

Creates a new CreateApiKeyResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CreateApiKeyResponse & $Properties

CreateApiKeyResponse instance

Call Signature​

static create(properties?): CreateApiKeyResponse

Creates a new CreateApiKeyResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CreateApiKeyResponse

CreateApiKeyResponse instance

decode()​

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

Decodes a CreateApiKeyResponse 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​

CreateApiKeyResponse & $Properties

CreateApiKeyResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CreateApiKeyResponse & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CreateApiKeyResponse & $Properties

CreateApiKeyResponse

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 CreateApiKeyResponse message. Does not implicitly temporal.api.cloud.cloudservice.v1.CreateApiKeyResponse.verify|verify messages.

Parameters​

message​

$Properties

CreateApiKeyResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CreateApiKeyResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CreateApiKeyResponse

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CreateApiKeyResponse

CreateApiKeyResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CreateApiKeyResponse

CreateApiKeyResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object