Skip to main content

Class: ApiKeySpec

Represents an ApiKeySpec.

Properties​

description​

description: string

The description of the API key.

disabled​

disabled: boolean

True if the API key is disabled.

displayName​

displayName: string

The display name of the API key.

expiryTime?​

optional expiryTime?: $Properties | null

The expiry time of the API key.

ownerId​

ownerId: string

The id of the owner to create the API key for. The owner id is immutable. Once set during creation, it cannot be changed. The owner id is the id of the user when the owner type is user. The owner id is the id of the service account when the owner type is service account.

ownerType​

ownerType: OwnerType

The type of the owner to create the API key for. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=owner_type_deprecated

ownerTypeDeprecated​

ownerTypeDeprecated: string

The type of the owner to create the API key for. The owner type is immutable. Once set during creation, it cannot be changed. Possible values: user, service-account. Deprecated: Not supported after v0.3.0 api version. Use owner_type instead. temporal:versioning:max_version=v0.3.0

Methods​

toJSON()​

toJSON(): object

Converts this ApiKeySpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ApiKeySpec & $Properties

Creates a new ApiKeySpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ApiKeySpec & $Properties

ApiKeySpec instance

Call Signature​

static create(properties?): ApiKeySpec

Creates a new ApiKeySpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ApiKeySpec

ApiKeySpec instance

decode()​

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

Decodes an ApiKeySpec 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​

ApiKeySpec & $Properties

ApiKeySpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ApiKeySpec & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ApiKeySpec & $Properties

ApiKeySpec

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

Parameters​

message​

$Properties

ApiKeySpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ApiKeySpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ApiKeySpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ApiKeySpec

ApiKeySpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ApiKeySpec

ApiKeySpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object