Skip to main content

Interface: WorkflowInfo

What workflow code knows about its run.

Extends​

Properties​

attempt?​

optional attempt?: number

Run-level retry attempt, 1-based (same value as runAttempt).

Inherited from​

WorkflowInfoSnapshot.attempt


buildId?​

optional buildId?: string

Inherited from​

WorkflowInfoSnapshot.buildId


businessId?​

optional businessId?: string

The column name of the workflow id (11 §2.1).

Inherited from​

WorkflowInfoSnapshot.businessId


context?​

optional context?: JsonObject

The run's memo (11 §2.22); memo is the same value under its Temporal name.

Inherited from​

WorkflowInfoSnapshot.context


continueAsNewSuggested​

readonly continueAsNewSuggested: boolean

True from 80 % of the history cap; continue as new soon.


continuedFromRunId?​

optional continuedFromRunId?: string

Inherited from​

WorkflowInfoSnapshot.continuedFromRunId


details?​

optional details?: string

Inherited from​

WorkflowInfoSnapshot.details


fairnessKey?​

optional fairnessKey?: string

Fairness of the run's tasks (11 §2.11).

Inherited from​

WorkflowInfoSnapshot.fairnessKey


fairnessWeight?​

optional fairnessWeight?: number

Inherited from​

WorkflowInfoSnapshot.fairnessWeight


firstRunId?​

optional firstRunId?: string

Inherited from​

WorkflowInfoSnapshot.firstRunId


headers?​

optional headers?: Headers

Inherited from​

WorkflowInfoSnapshot.headers


historyBytes​

readonly historyBytes: number

UTF-8 bytes of their payloads.


historyLength​

readonly historyLength: number

Events in the history when the current workflow task started.


historyLimit?​

optional historyLimit?: HistoryLimit

Inherited from​

WorkflowInfoSnapshot.historyLimit


isReplaying​

readonly isReplaying: boolean


lastFailure?​

optional lastFailure?: Failure

Inherited from​

WorkflowInfoSnapshot.lastFailure


lastResult?​

optional lastResult?: Json

Inherited from​

WorkflowInfoSnapshot.lastResult


memo?​

optional memo?: JsonObject

Inherited from​

WorkflowInfoSnapshot.memo


parentRunId?​

optional parentRunId?: string

Inherited from​

WorkflowInfoSnapshot.parentRunId


priority?​

optional priority?: number

Inherited from​

WorkflowInfoSnapshot.priority


retry?​

optional retry?: RunRetryPolicy

The run-level retry policy of the chain.

Inherited from​

WorkflowInfoSnapshot.retry


rootRunId?​

optional rootRunId?: string

Inherited from​

WorkflowInfoSnapshot.rootRunId


runAttempt?​

optional runAttempt?: number

Run-level retry attempt, 1-based (11 §2.17).

Inherited from​

WorkflowInfoSnapshot.runAttempt


runId​

runId: string

Inherited from​

WorkflowInfoSnapshot.runId


runStartedAt?​

optional runStartedAt?: string

Inherited from​

WorkflowInfoSnapshot.runStartedAt


searchAttributes?​

optional searchAttributes?: JsonObject

The run's search attributes at the start (11 §2.8).

Inherited from​

WorkflowInfoSnapshot.searchAttributes


startedAt?​

optional startedAt?: string

Inherited from​

WorkflowInfoSnapshot.startedAt


summary?​

optional summary?: string

Inherited from​

WorkflowInfoSnapshot.summary


taskQueue?​

optional taskQueue?: string

Inherited from​

WorkflowInfoSnapshot.taskQueue


timeouts?​

optional timeouts?: object

executionTimeout?​

optional executionTimeout?: number

runTimeout?​

optional runTimeout?: number

workflowTaskTimeout?​

optional workflowTaskTimeout?: number

Inherited from​

WorkflowInfoSnapshot.timeouts


version?​

optional version?: string | number

Inherited from​

WorkflowInfoSnapshot.version


versioningBehavior?​

optional versioningBehavior?: "PINNED" | "AUTO_UPGRADE"

Inherited from​

WorkflowInfoSnapshot.versioningBehavior


workflowFn​

readonly workflowFn: string


workflowId?​

optional workflowId?: string

The caller-chosen workflow id (businessId), else the first run's id.

Inherited from​

WorkflowInfoSnapshot.workflowId


workflowKey?​

optional workflowKey?: string

Inherited from​

WorkflowInfoSnapshot.workflowKey


workspaceId​

workspaceId: string

Inherited from​

WorkflowInfoSnapshot.workspaceId