Skip to main content

Class: WorkerListInfo

Limited worker information returned in the list response. When adding fields here, ensure that it is also added to WorkerInfo (as it carries the full worker information).

Properties​

deploymentVersion?​

optional deploymentVersion?: $Properties | null

WorkerListInfo deploymentVersion.

drivers​

drivers: $Properties[]

Storage drivers in use by this SDK.

hostName​

hostName: string

Worker host identifier.

plugins​

plugins: $Properties[]

Plugins currently in use by this SDK.

processId​

processId: string

Worker process identifier. This id only needs to be unique within one host (so using e.g. a unix pid would be appropriate).

sdkName​

sdkName: string

WorkerListInfo sdkName.

sdkVersion​

sdkVersion: string

WorkerListInfo sdkVersion.

startTime?​

optional startTime?: $Properties | null

Worker start time. It can be used to determine worker uptime. (current time - start time)

status​

status: WorkerStatus

Worker status. Defined by SDK.

taskQueue​

taskQueue: string

Task queue this worker is polling for tasks.

workerGroupingKey​

workerGroupingKey: string

Worker grouping identifier. A key to group workers that share the same client+namespace+process. This will be used to build the worker command nexus task queue name: "temporal-sys/worker-commands/{worker_grouping_key}"

workerIdentity​

workerIdentity: string

Worker identity, set by the client, may not be unique. Usually host_name+(user group name)+process_id, but can be overwritten by the user.

workerInstanceKey​

workerInstanceKey: string

Worker identifier, should be unique for the namespace. It is distinct from worker identity, which is not necessarily namespace-unique.

Methods​

toJSON()​

toJSON(): object

Converts this WorkerListInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkerListInfo & $Properties

Creates a new WorkerListInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerListInfo & $Properties

WorkerListInfo instance

Call Signature​

static create(properties?): WorkerListInfo

Creates a new WorkerListInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerListInfo

WorkerListInfo instance

decode()​

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

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

WorkerListInfo & $Properties

WorkerListInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkerListInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkerListInfo & $Properties

WorkerListInfo

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

Parameters​

message​

$Properties

WorkerListInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkerListInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkerListInfo

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

Parameters​

object​

Plain object

Returns​

WorkerListInfo

WorkerListInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkerListInfo

WorkerListInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object