Skip to main content

Class: Provisioned

v1.Capacity.Provisioned

Represents a Provisioned.

Implements

Constructors

constructor

new Provisioned(properties?): Provisioned

Constructs a new Provisioned.

Parameters

NameTypeDescription
properties?IProvisionedProperties to set

Returns

Provisioned

Properties

currentValue

currentValue: number

The current provisioned capacity for the namespace in Temporal Resource Units. Can be different from the requested capacity in latest_request if the request is still in progress.

Implementation of

IProvisioned.currentValue

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

NameTypeDescription
properties?IProvisionedProperties to set

Returns

Provisioned

Provisioned instance


decode

decode(reader, length?): Provisioned

Decodes a Provisioned message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

Provisioned

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

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Provisioned

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.Capacity.Provisioned.verify|verify messages.

Parameters

NameTypeDescription
messageIProvisionedProvisioned message or plain object to encode
writer?WriterWriter 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.Capacity.Provisioned.verify|verify messages.

Parameters

NameTypeDescription
messageIProvisionedProvisioned message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

Provisioned

Provisioned


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Provisioned

Parameters

NameTypeDescription
typeUrlPrefix?stringyour 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

NameTypeDescription
messageProvisionedProvisioned
options?IConversionOptionsConversion options

Returns

Object

Plain object