Skip to main content

Interface: IWorkerHeartbeat

Properties of a WorkerHeartbeat.

Extends​

Properties​

activityPollerInfo?​

optional activityPollerInfo?: $Properties | null

WorkerHeartbeat activityPollerInfo

Inherited from​

$Properties.activityPollerInfo

activityTaskSlotsInfo?​

optional activityTaskSlotsInfo?: $Properties | null

WorkerHeartbeat activityTaskSlotsInfo

Inherited from​

$Properties.activityTaskSlotsInfo

currentStickyCacheSize?​

optional currentStickyCacheSize?: number | null

Current cache size, expressed in number of Workflow Executions.

Inherited from​

$Properties.currentStickyCacheSize

deploymentVersion?​

optional deploymentVersion?: $Properties | null

WorkerHeartbeat deploymentVersion

Inherited from​

$Properties.deploymentVersion

drivers?​

optional drivers?: $Properties[] | null

Storage drivers in use by this SDK.

Inherited from​

$Properties.drivers

elapsedSinceLastHeartbeat?​

optional elapsedSinceLastHeartbeat?: $Properties | null

Elapsed time since the last heartbeat from the worker.

Inherited from​

$Properties.elapsedSinceLastHeartbeat

environment?​

optional environment?: $Properties | null

Information about the environment this SDK is running in.

Inherited from​

$Properties.environment

heartbeatTime?​

optional heartbeatTime?: $Properties | null

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?: $Properties | null

Worker host information.

Inherited from​

$Properties.hostInfo

localActivitySlotsInfo?​

optional localActivitySlotsInfo?: $Properties | null

WorkerHeartbeat localActivitySlotsInfo

Inherited from​

$Properties.localActivitySlotsInfo

nexusPollerInfo?​

optional nexusPollerInfo?: $Properties | null

WorkerHeartbeat nexusPollerInfo

Inherited from​

$Properties.nexusPollerInfo

nexusTaskSlotsInfo?​

optional nexusTaskSlotsInfo?: $Properties | null

WorkerHeartbeat nexusTaskSlotsInfo

Inherited from​

$Properties.nexusTaskSlotsInfo

plugins?​

optional plugins?: $Properties[] | null

Plugins currently in use by this SDK.

Inherited from​

$Properties.plugins

sdkName?​

optional sdkName?: string | null

WorkerHeartbeat sdkName

Inherited from​

$Properties.sdkName

sdkVersion?​

optional sdkVersion?: string | null

WorkerHeartbeat sdkVersion

Inherited from​

$Properties.sdkVersion

startTime?​

optional startTime?: $Properties | null

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

Inherited from​

$Properties.startTime

status?​

optional status?: WorkerStatus | null

Worker status. Defined by SDK.

Inherited from​

$Properties.status

taskQueue?​

optional taskQueue?: string | null

Task queue this worker is polling for tasks.

Inherited from​

$Properties.taskQueue

totalStickyCacheHit?​

optional totalStickyCacheHit?: number | null

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

Inherited from​

$Properties.totalStickyCacheHit

totalStickyCacheMiss?​

optional totalStickyCacheMiss?: number | null

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

Inherited from​

$Properties.totalStickyCacheMiss

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.

Inherited from​

$Properties.workerIdentity

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.

Inherited from​

$Properties.workerInstanceKey

workflowPollerInfo?​

optional workflowPollerInfo?: $Properties | null

WorkerHeartbeat workflowPollerInfo

Inherited from​

$Properties.workflowPollerInfo

workflowStickyPollerInfo?​

optional workflowStickyPollerInfo?: $Properties | null

WorkerHeartbeat workflowStickyPollerInfo

Inherited from​

$Properties.workflowStickyPollerInfo

workflowTaskSlotsInfo?​

optional workflowTaskSlotsInfo?: $Properties | null

WorkerHeartbeat workflowTaskSlotsInfo

Inherited from​

$Properties.workflowTaskSlotsInfo