Skip to main content

Interface: $Properties

v1.WorkerHeartbeat.$Properties

Properties of a WorkerHeartbeat.

Hierarchy​

Properties​

activityPollerInfo​

• Optional activityPollerInfo: null | $Properties

WorkerHeartbeat activityPollerInfo


activityTaskSlotsInfo​

• Optional activityTaskSlotsInfo: null | $Properties

WorkerHeartbeat activityTaskSlotsInfo


currentStickyCacheSize​

• Optional currentStickyCacheSize: null | number

Current cache size, expressed in number of Workflow Executions.


deploymentVersion​

• Optional deploymentVersion: null | $Properties

WorkerHeartbeat deploymentVersion


drivers​

• Optional drivers: null | $Properties[]

Storage drivers in use by this SDK.


elapsedSinceLastHeartbeat​

• Optional elapsedSinceLastHeartbeat: null | $Properties

Elapsed time since the last heartbeat from the worker.


environment​

• Optional environment: null | $Properties

Information about the environment this SDK is running in.


heartbeatTime​

• Optional heartbeatTime: null | $Properties

Timestamp of this heartbeat, coming from the worker. Worker should set it to "now". Note that this timestamp comes directly from the worker and is subject to workers' clock skew.


hostInfo​

• Optional hostInfo: null | $Properties

Worker host information.


localActivitySlotsInfo​

• Optional localActivitySlotsInfo: null | $Properties

WorkerHeartbeat localActivitySlotsInfo


nexusPollerInfo​

• Optional nexusPollerInfo: null | $Properties

WorkerHeartbeat nexusPollerInfo


nexusTaskSlotsInfo​

• Optional nexusTaskSlotsInfo: null | $Properties

WorkerHeartbeat nexusTaskSlotsInfo


plugins​

• Optional plugins: null | $Properties[]

Plugins currently in use by this SDK.


sdkName​

• Optional sdkName: null | string

WorkerHeartbeat sdkName


sdkVersion​

• Optional sdkVersion: null | string

WorkerHeartbeat sdkVersion


startTime​

• Optional startTime: null | $Properties

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.


totalStickyCacheHit​

• Optional totalStickyCacheHit: null | number

A Workflow Task found a cached Workflow Execution to run against.


totalStickyCacheMiss​

• Optional totalStickyCacheMiss: null | number

A Workflow Task did not find a cached Workflow execution to run against.


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.


workflowPollerInfo​

• Optional workflowPollerInfo: null | $Properties

WorkerHeartbeat workflowPollerInfo


workflowStickyPollerInfo​

• Optional workflowStickyPollerInfo: null | $Properties

WorkerHeartbeat workflowStickyPollerInfo


workflowTaskSlotsInfo​

• Optional workflowTaskSlotsInfo: null | $Properties

WorkerHeartbeat workflowTaskSlotsInfo