Skip to main content

Interface: $Properties

Properties of a WorkerListInfo.

Extended by​

Properties​

deploymentVersion?​

optional deploymentVersion?: $Properties | null

WorkerListInfo deploymentVersion

drivers?​

optional drivers?: $Properties[] | null

Storage drivers in use by this SDK.

hostName?​

optional hostName?: string | null

Worker host identifier.

plugins?​

optional plugins?: $Properties[] | null

Plugins currently in use by this SDK.

processId?​

optional processId?: string | null

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?: string | null

WorkerListInfo sdkName

sdkVersion?​

optional sdkVersion?: string | null

WorkerListInfo sdkVersion

startTime?​

optional startTime?: $Properties | null

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

status?​

optional status?: WorkerStatus | null

Worker status. Defined by SDK.

taskQueue?​

optional taskQueue?: string | null

Task queue this worker is polling for tasks.

workerGroupingKey?​

optional workerGroupingKey?: string | null

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?: string | null

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?: string | null

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