Skip to main content

Class: CapacityModeOptions

v1.NamespaceCapacityInfo.CapacityModeOptions

Represents a CapacityModeOptions.

Properties

onDemand

Optional onDemand: null | $Properties

On-Demand capacity information.


provisioned

Optional provisioned: null | $Properties

Provisioned capacity options and entitlements.

Methods

toJSON

toJSON(): Object

Converts this CapacityModeOptions to JSON.

Returns

Object

JSON object


create

create(properties?): CapacityModeOptions & $Properties

Creates a new CapacityModeOptions instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

CapacityModeOptions & $Properties

CapacityModeOptions instance

create(properties?): CapacityModeOptions

Parameters

NameType
properties?$Properties

Returns

CapacityModeOptions


decode

decode(reader, length?): CapacityModeOptions & $Properties

Decodes a CapacityModeOptions message from the specified reader or buffer.

Parameters

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

Returns

CapacityModeOptions & $Properties

CapacityModeOptions

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): CapacityModeOptions & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

CapacityModeOptions & $Properties

CapacityModeOptions

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

Parameters

NameTypeDescription
message$PropertiesCapacityModeOptions message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesCapacityModeOptions message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): CapacityModeOptions

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

CapacityModeOptions

CapacityModeOptions


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageCapacityModeOptionsCapacityModeOptions
options?IConversionOptionsConversion options

Returns

Object

Plain object