Skip to main content

Interface: RunState

A run as its history describes it.

Properties​

activities​

activities: Record<string, ActivityState>


cancelRequested​

cancelRequested: boolean


children​

children: Record<string, ChildState>


completedTasks​

completedTasks: number

Workflow tasks completed so far.


context​

context: JsonObject


externals​

externals: Record<string, ExternalState>


failure?​

optional failure?: Failure


historyBytes​

historyBytes: number

UTF-8 bytes of the JSON payloads (the inline-bytes cap counts these).


historyLength​

historyLength: number


input?​

optional input?: Json


lastEventAt?​

optional lastEventAt?: string


localActivities​

localActivities: Record<string, LocalActivityState>


markers​

markers: Record<string, Json>


output?​

optional output?: Json


searchAttributes​

searchAttributes: JsonObject

Search attributes: the start's, merged with every upsert; null removes a key.


sideEffects​

sideEffects: Record<string, Json>


signalsReceived​

signalsReceived: number


status​

status: RunStatus


task​

task: object

The workflow task: none pending, scheduled, or started (by taskId).

attempt​

attempt: number

state​

state: "SCHEDULED" | "STARTED" | "NONE"

taskId?​

optional taskId?: string


taskFailures​

taskFailures: number

Consecutive failed attempts of the current task.


timers​

timers: Record<string, TimerState>


updates​

updates: Record<string, UpdateState>

Updates by id.


workflowFn?​

optional workflowFn?: string