Skip to main content

Class: Provisioned

Represents a Provisioned.

Properties​

value​

value: number

The units of provisioned capacity in TRU (Temporal Resource Units). Each TRU unit assigned to the namespace will entitle it with additional APS limits as specified in the documentation.

Methods​

toJSON()​

toJSON(): object

Converts this Provisioned to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Provisioned & $Properties

Creates a new Provisioned instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Provisioned & $Properties

Provisioned instance

Call Signature​

static create(properties?): Provisioned

Creates a new Provisioned instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Provisioned

Provisioned instance

decode()​

static decode(reader, length?): Provisioned & $Properties

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

Provisioned & $Properties

Provisioned

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Provisioned & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Provisioned & $Properties

Provisioned

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

Parameters​

message​

$Properties

Provisioned message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Provisioned message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Provisioned

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Provisioned

Provisioned

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Provisioned

Provisioned

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object