Interface: WorkflowInfo
What workflow code knows about its run.
Extends
Properties
attempt?
optionalattempt?:number
Run-level retry attempt, 1-based (same value as runAttempt).
Inherited from
buildId?
optionalbuildId?:string
Inherited from
businessId?
optionalbusinessId?:string
The column name of the workflow id (11 §2.1).
Inherited from
WorkflowInfoSnapshot.businessId
context?
optionalcontext?:JsonObject
The run's memo (11 §2.22); memo is the same value under its Temporal name.
Inherited from
continueAsNewSuggested
readonlycontinueAsNewSuggested:boolean
True from 80 % of the history cap; continue as new soon.
continuedFromRunId?
optionalcontinuedFromRunId?:string
Inherited from
WorkflowInfoSnapshot.continuedFromRunId
details?
optionaldetails?:string
Inherited from
fairnessKey?
optionalfairnessKey?:string
Fairness of the run's tasks (11 §2.11).
Inherited from
WorkflowInfoSnapshot.fairnessKey
fairnessWeight?
optionalfairnessWeight?:number
Inherited from
WorkflowInfoSnapshot.fairnessWeight
firstRunId?
optionalfirstRunId?:string
Inherited from
WorkflowInfoSnapshot.firstRunId
headers?
optionalheaders?:Headers
Inherited from
historyBytes
readonlyhistoryBytes:number
UTF-8 bytes of their payloads.
historyLength
readonlyhistoryLength:number
Events in the history when the current workflow task started.
historyLimit?
optionalhistoryLimit?:HistoryLimit
Inherited from
WorkflowInfoSnapshot.historyLimit
isReplaying
readonlyisReplaying:boolean
lastFailure?
optionallastFailure?:Failure
Inherited from
WorkflowInfoSnapshot.lastFailure
lastResult?
optionallastResult?:Json
Inherited from
WorkflowInfoSnapshot.lastResult
memo?
optionalmemo?:JsonObject
Inherited from
parentRunId?
optionalparentRunId?:string
Inherited from
WorkflowInfoSnapshot.parentRunId
priority?
optionalpriority?:number
Inherited from
retry?
optionalretry?:RunRetryPolicy
The run-level retry policy of the chain.
Inherited from
rootRunId?
optionalrootRunId?:string
Inherited from
WorkflowInfoSnapshot.rootRunId
runAttempt?
optionalrunAttempt?:number
Run-level retry attempt, 1-based (11 §2.17).
Inherited from
WorkflowInfoSnapshot.runAttempt
runId
runId:
string
Inherited from
runStartedAt?
optionalrunStartedAt?:string
Inherited from
WorkflowInfoSnapshot.runStartedAt
searchAttributes?
optionalsearchAttributes?:JsonObject
The run's search attributes at the start (11 §2.8).
Inherited from
WorkflowInfoSnapshot.searchAttributes
startedAt?
optionalstartedAt?:string
Inherited from
WorkflowInfoSnapshot.startedAt
summary?
optionalsummary?:string
Inherited from
taskQueue?
optionaltaskQueue?:string
Inherited from
WorkflowInfoSnapshot.taskQueue
timeouts?
optionaltimeouts?:object
executionTimeout?
optionalexecutionTimeout?:number
runTimeout?
optionalrunTimeout?:number
workflowTaskTimeout?
optionalworkflowTaskTimeout?:number
Inherited from
version?
optionalversion?:string|number
Inherited from
versioningBehavior?
optionalversioningBehavior?:"PINNED"|"AUTO_UPGRADE"
Inherited from
WorkflowInfoSnapshot.versioningBehavior
workflowFn
readonlyworkflowFn:string
workflowId?
optionalworkflowId?:string
The caller-chosen workflow id (businessId), else the first run's id.
Inherited from
WorkflowInfoSnapshot.workflowId
workflowKey?
optionalworkflowKey?:string
Inherited from
WorkflowInfoSnapshot.workflowKey
workspaceId
workspaceId:
string