Skip to main content

Class: ComputeConfig

ComputeConfig stores configuration that helps a worker control plane controller understand when and how to respond to worker lifecycle events.

Properties​

scalingGroups​

scalingGroups: object

Each scaling group describes a compute config for a specific subset of the worker deployment version: covering a specific set of task types and/or regions. Having different configurations for different task types, allows independent tuning of activity and workflow task processing (for example).

The key of the map is the ID of the scaling group used to reference it in subsequent update calls.

Index Signature​

[k: string]: $Properties

Methods​

toJSON()​

toJSON(): object

Converts this ComputeConfig to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): ComputeConfig & $Properties

Creates a new ComputeConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ComputeConfig & $Properties

ComputeConfig instance

Call Signature​

static create(properties?): ComputeConfig

Creates a new ComputeConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ComputeConfig

ComputeConfig instance


decode()​

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

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

ComputeConfig & $Properties

ComputeConfig

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): ComputeConfig & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ComputeConfig & $Properties

ComputeConfig

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 ComputeConfig message. Does not implicitly temporal.api.compute.v1.ComputeConfig.verify|verify messages.

Parameters​

message​

$Properties

ComputeConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ComputeConfig message, length delimited. Does not implicitly temporal.api.compute.v1.ComputeConfig.verify|verify messages.

Parameters​

message​

$Properties

ComputeConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): ComputeConfig

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

Parameters​

object​

Plain object

Returns​

ComputeConfig

ComputeConfig


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ComputeConfig

ComputeConfig

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object