Skip to main content

Class: DeleteApiKeyRequest

Represents a DeleteApiKeyRequest.

Properties​

asyncOperationId​

asyncOperationId: string

The id to use for this async operation - optional.

keyId​

keyId: string

The id of the api key to delete.

resourceVersion​

resourceVersion: string

The version of the api key for which this delete is intended for. The latest version can be found in the GetApiKey operation response.

Methods​

toJSON()​

toJSON(): object

Converts this DeleteApiKeyRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DeleteApiKeyRequest & $Properties

Creates a new DeleteApiKeyRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteApiKeyRequest & $Properties

DeleteApiKeyRequest instance

Call Signature​

static create(properties?): DeleteApiKeyRequest

Creates a new DeleteApiKeyRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteApiKeyRequest

DeleteApiKeyRequest instance

decode()​

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

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

DeleteApiKeyRequest & $Properties

DeleteApiKeyRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DeleteApiKeyRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DeleteApiKeyRequest & $Properties

DeleteApiKeyRequest

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

Parameters​

message​

$Properties

DeleteApiKeyRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DeleteApiKeyRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DeleteApiKeyRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

DeleteApiKeyRequest

DeleteApiKeyRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DeleteApiKeyRequest

DeleteApiKeyRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object