Skip to main content

Class: ComputeConfig

compute.v1.ComputeConfig

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

Implements

Constructors

constructor

new ComputeConfig(properties?): ComputeConfig

Constructs a new ComputeConfig.

Parameters

NameTypeDescription
properties?IComputeConfigProperties to set

Returns

ComputeConfig

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]: IComputeConfigScalingGroup

Implementation of

IComputeConfig.scalingGroups

Methods

toJSON

toJSON(): Object

Converts this ComputeConfig to JSON.

Returns

Object

JSON object


create

create(properties?): ComputeConfig

Creates a new ComputeConfig instance using the specified properties.

Parameters

NameTypeDescription
properties?IComputeConfigProperties to set

Returns

ComputeConfig

ComputeConfig instance


decode

decode(reader, length?): ComputeConfig

Decodes a ComputeConfig message from the specified reader or buffer.

Parameters

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

Returns

ComputeConfig

ComputeConfig

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ComputeConfig

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ComputeConfig

ComputeConfig

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

Parameters

NameTypeDescription
messageIComputeConfigComputeConfig message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIComputeConfigComputeConfig message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ComputeConfig

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ComputeConfig

ComputeConfig


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ComputeConfig

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 ComputeConfig message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageComputeConfigComputeConfig
options?IConversionOptionsConversion options

Returns

Object

Plain object