Skip to main content

Class: GetApiKeysRequest

Represents a GetApiKeysRequest.

Properties​

ownerId​

ownerId: string

Filter api keys by owner id - optional.

ownerType​

ownerType: OwnerType

Filter api keys by owner type - optional. temporal:enums:replaces=owner_type_deprecated

ownerTypeDeprecated​

ownerTypeDeprecated: string

Filter api keys by owner type - optional. Possible values: user, service-account temporal:versioning:max_version=v0.3.0

pageSize​

pageSize: number

The requested size of the page to retrieve - optional. Cannot exceed 1000. Defaults to 100.

pageToken​

pageToken: string

The page token if this is continuing from another response - optional.

Methods​

toJSON()​

toJSON(): object

Converts this GetApiKeysRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): GetApiKeysRequest & $Properties

Creates a new GetApiKeysRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetApiKeysRequest & $Properties

GetApiKeysRequest instance

Call Signature​

static create(properties?): GetApiKeysRequest

Creates a new GetApiKeysRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetApiKeysRequest

GetApiKeysRequest instance

decode()​

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

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

GetApiKeysRequest & $Properties

GetApiKeysRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): GetApiKeysRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

GetApiKeysRequest & $Properties

GetApiKeysRequest

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

Parameters​

message​

$Properties

GetApiKeysRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

GetApiKeysRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): GetApiKeysRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

GetApiKeysRequest

GetApiKeysRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

GetApiKeysRequest

GetApiKeysRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object