Skip to main content

Class: NamespaceCapacityInfo

NamespaceCapacityInfo contains detailed capacity information for a namespace.

Properties​

currentCapacity?​

optional currentCapacity?: $Properties | null

The current capacity of the namespace. Includes the current mode (on-demand or provisioned) and latest request status.

hasLegacyLimits​

hasLegacyLimits: boolean

Whether the namespace's APS limit was set by Temporal Support. When true, adjusting the namespace's capacity will reset this limit.

modeOptions?​

optional modeOptions?: $Properties | null

Available capacity mode options for this namespace. Contains configuration limits for both provisioned and on-demand modes.

namespace​

namespace: string

The namespace identifier.

stats?​

optional stats?: $Properties | null

Usage statistics for the namespace over the last 7 days. Used to calculate On-Demand capacity limits, also useful for capacity planning.

Methods​

toJSON()​

toJSON(): object

Converts this NamespaceCapacityInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NamespaceCapacityInfo & $Shape

Creates a new NamespaceCapacityInfo instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

NamespaceCapacityInfo & $Shape

NamespaceCapacityInfo instance

Call Signature​

static create(properties?): NamespaceCapacityInfo

Creates a new NamespaceCapacityInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NamespaceCapacityInfo

NamespaceCapacityInfo instance

decode()​

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

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

NamespaceCapacityInfo & $Shape

NamespaceCapacityInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NamespaceCapacityInfo & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NamespaceCapacityInfo & $Shape

NamespaceCapacityInfo

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

Parameters​

message​

$Properties

NamespaceCapacityInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NamespaceCapacityInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NamespaceCapacityInfo

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

NamespaceCapacityInfo

NamespaceCapacityInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NamespaceCapacityInfo

NamespaceCapacityInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object