Skip to main content

Interface: IWorkerListInfo

worker.v1.IWorkerListInfo

Properties of a WorkerListInfo.

Implemented by

Properties

deploymentVersion

Optional deploymentVersion: null | IWorkerDeploymentVersion

WorkerListInfo deploymentVersion


drivers

Optional drivers: null | IStorageDriverInfo[]

Storage drivers in use by this SDK.


hostName

Optional hostName: null | string

Worker host identifier.


plugins

Optional plugins: null | IPluginInfo[]

Plugins currently in use by this SDK.


processId

Optional processId: null | 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

Optional sdkName: null | string

WorkerListInfo sdkName


sdkVersion

Optional sdkVersion: null | string

WorkerListInfo sdkVersion


startTime

Optional startTime: null | ITimestamp

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


status

Optional status: null | WorkerStatus

Worker status. Defined by SDK.


taskQueue

Optional taskQueue: null | string

Task queue this worker is polling for tasks.


workerGroupingKey

Optional workerGroupingKey: null | 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

Optional workerIdentity: null | 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

Optional workerInstanceKey: null | string

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