Skip to main content

Class: CapacityModeOptions

Represents a CapacityModeOptions.

Properties​

onDemand?​

optional onDemand?: $Properties | null

On-Demand capacity information.

provisioned?​

optional provisioned?: $Properties | null

Provisioned capacity options and entitlements.

Methods​

toJSON()​

toJSON(): object

Converts this CapacityModeOptions to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CapacityModeOptions & $Properties

Creates a new CapacityModeOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CapacityModeOptions & $Properties

CapacityModeOptions instance

Call Signature​

static create(properties?): CapacityModeOptions

Creates a new CapacityModeOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CapacityModeOptions

CapacityModeOptions instance

decode()​

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

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

CapacityModeOptions & $Properties

CapacityModeOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CapacityModeOptions & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader 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()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

CapacityModeOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static 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​

message​

$Properties

CapacityModeOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CapacityModeOptions

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CapacityModeOptions

CapacityModeOptions

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CapacityModeOptions

CapacityModeOptions

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object