Class: NamespaceCapacityInfo

namespace.v1.NamespaceCapacityInfo

NamespaceCapacityInfo contains detailed capacity information for a namespace.

Implements

• INamespaceCapacityInfo

Constructors

constructor

• new NamespaceCapacityInfo(properties?): NamespaceCapacityInfo

Constructs a new NamespaceCapacityInfo.

Parameters

Name	Type	Description
properties?	INamespaceCapacityInfo	Properties to set

Returns

NamespaceCapacityInfo

Properties

currentCapacity

• Optional currentCapacity: null | ICapacity

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

Implementation of

INamespaceCapacityInfo.currentCapacity

---

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.

Implementation of

INamespaceCapacityInfo.hasLegacyLimits

---

modeOptions

• Optional modeOptions: null | ICapacityModeOptions

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

Implementation of

INamespaceCapacityInfo.modeOptions

---

namespace

• namespace: string

The namespace identifier.

Implementation of

INamespaceCapacityInfo.namespace

---

stats

• Optional stats: null | IStats

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

Implementation of

INamespaceCapacityInfo.stats

Methods

toJSON

▸ toJSON(): Object

Converts this NamespaceCapacityInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): NamespaceCapacityInfo

Creates a new NamespaceCapacityInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	INamespaceCapacityInfo	Properties to set

Returns

NamespaceCapacityInfo

NamespaceCapacityInfo instance

---

decode

▸ decode(reader, length?): NamespaceCapacityInfo

Decodes a NamespaceCapacityInfo message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

NamespaceCapacityInfo

NamespaceCapacityInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): NamespaceCapacityInfo

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

NamespaceCapacityInfo

NamespaceCapacityInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	INamespaceCapacityInfo	NamespaceCapacityInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	INamespaceCapacityInfo	NamespaceCapacityInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): NamespaceCapacityInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

NamespaceCapacityInfo

NamespaceCapacityInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for NamespaceCapacityInfo

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	NamespaceCapacityInfo	NamespaceCapacityInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object