Skip to main content

Class: Capacity

Represents a Capacity.

Properties​

currentMode?​

optional currentMode?: "onDemand" | "provisioned"

Capacity currentMode.

latestRequest?​

optional latestRequest?: $Properties | null

The latest requested capacity for the namespace, if any.

onDemand?​

optional onDemand?: $Properties | null

The status of on-demand capacity mode.

provisioned?​

optional provisioned?: $Properties | null

The status of provisioned capacity mode.

Methods​

toJSON()​

toJSON(): object

Converts this Capacity to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Capacity & $Shape

Creates a new Capacity instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Capacity & $Shape

Capacity instance

Call Signature​

static create(properties?): Capacity

Creates a new Capacity instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Capacity

Capacity instance

decode()​

static decode(reader, length?): Capacity & $Shape

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

Capacity & $Shape

Capacity

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Capacity & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Capacity & $Shape

Capacity

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

Parameters​

message​

$Properties

Capacity message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Capacity message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Capacity

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Capacity

Capacity

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Capacity

Capacity

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object