Class: Provisioned
NamespaceCapacityInfo.CapacityModeOptions.Provisioned
Represents a Provisioned.
Implements
Constructors
constructor
• new Provisioned(properties?): Provisioned
Constructs a new Provisioned.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IProvisioned | Properties to set |
Returns
Properties
maxAvailableTruValue
• maxAvailableTruValue: number
The maximum TRU value that can currently be set for this namespace. This may be lower than the highest value in valid_tru_values due to inventory constraints.
Implementation of
IProvisioned.maxAvailableTruValue
validTruValues
• validTruValues: number[]
The valid TRU (Temporal Resource Unit) values that can be set. These are the discrete capacity tiers available for selection.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Provisioned to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Provisioned
Creates a new Provisioned instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IProvisioned | Properties to set |
Returns
Provisioned instance
decode
▸ decode(reader, length?): Provisioned
Decodes a Provisioned 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
Provisioned
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Provisioned
Decodes a Provisioned message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Provisioned
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 Provisioned message. Does not implicitly temporal.api.cloud.namespace.v1.NamespaceCapacityInfo.CapacityModeOptions.Provisioned.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IProvisioned | Provisioned message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Provisioned message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.NamespaceCapacityInfo.CapacityModeOptions.Provisioned.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IProvisioned | Provisioned message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Provisioned
Creates a Provisioned message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Provisioned
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Provisioned
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 Provisioned message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Provisioned | Provisioned |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object