Skip to main content

Interface: $Properties

Properties of a WorkerHeartbeat.

Extended by​

Properties​

activityPollerInfo?​

optional activityPollerInfo?: $Properties | null

WorkerHeartbeat activityPollerInfo

activityTaskSlotsInfo?​

optional activityTaskSlotsInfo?: $Properties | null

WorkerHeartbeat activityTaskSlotsInfo

currentStickyCacheSize?​

optional currentStickyCacheSize?: number | null

Current cache size, expressed in number of Workflow Executions.

deploymentVersion?​

optional deploymentVersion?: $Properties | null

WorkerHeartbeat deploymentVersion

drivers?​

optional drivers?: $Properties[] | null

Storage drivers in use by this SDK.

elapsedSinceLastHeartbeat?​

optional elapsedSinceLastHeartbeat?: $Properties | null

Elapsed time since the last heartbeat from the worker.

environment?​

optional environment?: $Properties | null

Information about the environment this SDK is running in.

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.

hostInfo?​

optional hostInfo?: $Properties | null

Worker host information.

localActivitySlotsInfo?​

optional localActivitySlotsInfo?: $Properties | null

WorkerHeartbeat localActivitySlotsInfo

nexusPollerInfo?​

optional nexusPollerInfo?: $Properties | null

WorkerHeartbeat nexusPollerInfo

nexusTaskSlotsInfo?​

optional nexusTaskSlotsInfo?: $Properties | null

WorkerHeartbeat nexusTaskSlotsInfo

plugins?​

optional plugins?: $Properties[] | null

Plugins currently in use by this SDK.

sdkName?​

optional sdkName?: string | null

WorkerHeartbeat sdkName

sdkVersion?​

optional sdkVersion?: string | null

WorkerHeartbeat 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.

totalStickyCacheHit?​

optional totalStickyCacheHit?: number | null

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

totalStickyCacheMiss?​

optional totalStickyCacheMiss?: number | null

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

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.

workflowPollerInfo?​

optional workflowPollerInfo?: $Properties | null

WorkerHeartbeat workflowPollerInfo

workflowStickyPollerInfo?​

optional workflowStickyPollerInfo?: $Properties | null

WorkerHeartbeat workflowStickyPollerInfo

workflowTaskSlotsInfo?​

optional workflowTaskSlotsInfo?: $Properties | null

WorkerHeartbeat workflowTaskSlotsInfo