Skip to main content

Interface: IWorkerHeartbeat

worker.v1.IWorkerHeartbeat

Properties of a WorkerHeartbeat.

Hierarchy​

Properties​

activityPollerInfo​

• Optional activityPollerInfo: null | $Properties

WorkerHeartbeat activityPollerInfo

Inherited from​

$Properties.activityPollerInfo


activityTaskSlotsInfo​

• Optional activityTaskSlotsInfo: null | $Properties

WorkerHeartbeat activityTaskSlotsInfo

Inherited from​

$Properties.activityTaskSlotsInfo


currentStickyCacheSize​

• Optional currentStickyCacheSize: null | number

Current cache size, expressed in number of Workflow Executions.

Inherited from​

$Properties.currentStickyCacheSize


deploymentVersion​

• Optional deploymentVersion: null | $Properties

WorkerHeartbeat deploymentVersion

Inherited from​

$Properties.deploymentVersion


drivers​

• Optional drivers: null | $Properties[]

Storage drivers in use by this SDK.

Inherited from​

$Properties.drivers


elapsedSinceLastHeartbeat​

• Optional elapsedSinceLastHeartbeat: null | $Properties

Elapsed time since the last heartbeat from the worker.

Inherited from​

$Properties.elapsedSinceLastHeartbeat


environment​

• Optional environment: null | $Properties

Information about the environment this SDK is running in.

Inherited from​

$Properties.environment


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.

Inherited from​

$Properties.heartbeatTime


hostInfo​

• Optional hostInfo: null | $Properties

Worker host information.

Inherited from​

$Properties.hostInfo


localActivitySlotsInfo​

• Optional localActivitySlotsInfo: null | $Properties

WorkerHeartbeat localActivitySlotsInfo

Inherited from​

$Properties.localActivitySlotsInfo


nexusPollerInfo​

• Optional nexusPollerInfo: null | $Properties

WorkerHeartbeat nexusPollerInfo

Inherited from​

$Properties.nexusPollerInfo


nexusTaskSlotsInfo​

• Optional nexusTaskSlotsInfo: null | $Properties

WorkerHeartbeat nexusTaskSlotsInfo

Inherited from​

$Properties.nexusTaskSlotsInfo


plugins​

• Optional plugins: null | $Properties[]

Plugins currently in use by this SDK.

Inherited from​

$Properties.plugins


sdkName​

• Optional sdkName: null | string

WorkerHeartbeat sdkName

Inherited from​

$Properties.sdkName


sdkVersion​

• Optional sdkVersion: null | string

WorkerHeartbeat sdkVersion

Inherited from​

$Properties.sdkVersion


startTime​

• Optional startTime: null | $Properties

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

Inherited from​

$Properties.startTime


status​

• Optional status: null | WorkerStatus

Worker status. Defined by SDK.

Inherited from​

$Properties.status


taskQueue​

• Optional taskQueue: null | string

Task queue this worker is polling for tasks.

Inherited from​

$Properties.taskQueue


totalStickyCacheHit​

• Optional totalStickyCacheHit: null | number

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

Inherited from​

$Properties.totalStickyCacheHit


totalStickyCacheMiss​

• Optional totalStickyCacheMiss: null | number

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

Inherited from​

$Properties.totalStickyCacheMiss


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.

Inherited from​

$Properties.workerIdentity


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.

Inherited from​

$Properties.workerInstanceKey


workflowPollerInfo​

• Optional workflowPollerInfo: null | $Properties

WorkerHeartbeat workflowPollerInfo

Inherited from​

$Properties.workflowPollerInfo


workflowStickyPollerInfo​

• Optional workflowStickyPollerInfo: null | $Properties

WorkerHeartbeat workflowStickyPollerInfo

Inherited from​

$Properties.workflowStickyPollerInfo


workflowTaskSlotsInfo​

• Optional workflowTaskSlotsInfo: null | $Properties

WorkerHeartbeat workflowTaskSlotsInfo

Inherited from​

$Properties.workflowTaskSlotsInfo