Class: NamespaceCapacityInfo
namespace.v1.NamespaceCapacityInfo
NamespaceCapacityInfo contains detailed capacity information for a namespace.
Properties
currentCapacity
• Optional currentCapacity: null | $Properties
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: null | $Properties
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: null | $Properties
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
▸ create(properties?): NamespaceCapacityInfo & $Shape
Creates a new NamespaceCapacityInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
NamespaceCapacityInfo & $Shape
NamespaceCapacityInfo instance
▸ create(properties?): NamespaceCapacityInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): NamespaceCapacityInfo & $Shape
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 & $Shape
NamespaceCapacityInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NamespaceCapacityInfo & $Shape
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 & $Shape
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 | $Properties | 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 | $Properties | 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
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