Skip to main content

Class: CapacitySpec

temporal:versioning:min_version=v0.10.0

Properties​

onDemand?​

optional onDemand?: $Properties | null

The on-demand capacity mode configuration.

provisioned?​

optional provisioned?: $Properties | null

The provisioned capacity mode configuration.

spec?​

optional spec?: "onDemand" | "provisioned"

CapacitySpec spec.

Methods​

toJSON()​

toJSON(): object

Converts this CapacitySpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CapacitySpec & $Shape

Creates a new CapacitySpec instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

CapacitySpec & $Shape

CapacitySpec instance

Call Signature​

static create(properties?): CapacitySpec

Creates a new CapacitySpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CapacitySpec

CapacitySpec instance

decode()​

static decode(reader, length?): CapacitySpec & $Shape

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

CapacitySpec & $Shape

CapacitySpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CapacitySpec & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CapacitySpec & $Shape

CapacitySpec

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

Parameters​

message​

$Properties

CapacitySpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CapacitySpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CapacitySpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CapacitySpec

CapacitySpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CapacitySpec

CapacitySpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object