Skip to main content

Class: WorkerConfig

sdk.v1.WorkerConfig

Represents a WorkerConfig.

Properties​

autoscalingPollerBehavior​

• Optional autoscalingPollerBehavior: null | $Properties

WorkerConfig autoscalingPollerBehavior.


pollerBehavior​

• Optional pollerBehavior: "simplePollerBehavior" | "autoscalingPollerBehavior"

WorkerConfig pollerBehavior.


simplePollerBehavior​

• Optional simplePollerBehavior: null | $Properties

WorkerConfig simplePollerBehavior.


workflowCacheSize​

• workflowCacheSize: number

WorkerConfig workflowCacheSize.

Methods​

toJSON​

▸ toJSON(): Object

Converts this WorkerConfig to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): WorkerConfig & $Shape

Creates a new WorkerConfig instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

WorkerConfig & $Shape

WorkerConfig instance

▸ create(properties?): WorkerConfig

Parameters​

NameType
properties?$Properties

Returns​

WorkerConfig


decode​

▸ decode(reader, length?): WorkerConfig & $Shape

Decodes a WorkerConfig message from the specified reader or buffer.

Parameters​

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

Returns​

WorkerConfig & $Shape

WorkerConfig

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): WorkerConfig & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

WorkerConfig & $Shape

WorkerConfig

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): WorkerConfig

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

WorkerConfig

WorkerConfig


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageWorkerConfigWorkerConfig
options?IConversionOptionsConversion options

Returns​

Object

Plain object