Skip to main content

Interface: IWorkflowExecutionInfo

workflow.v1.IWorkflowExecutionInfo

Properties of a WorkflowExecutionInfo.

Implemented by​

Properties​

assignedBuildId​

• Optional assignedBuildId: null | string

The currently assigned build ID for this execution. Presence of this value means worker versioning is used for this execution. Assigned build ID is selected based on Worker Versioning Assignment Rules when the first workflow task of the execution is scheduled. If the first workflow task fails and is scheduled again, the assigned build ID may change according to the latest versioning rules. Assigned build ID can also change in the middle of a execution if Compatible Redirect Rules are applied to this execution.

autoResetPoints​

• Optional autoResetPoints: null | IResetPoints

WorkflowExecutionInfo autoResetPoints

closeTime​

• Optional closeTime: null | ITimestamp

WorkflowExecutionInfo closeTime

execution​

• Optional execution: null | IWorkflowExecution

WorkflowExecutionInfo execution

executionDuration​

• Optional executionDuration: null | IDuration

Workflow execution duration is defined as difference between close time and execution time. This field is only populated if the workflow is closed.

executionTime​

• Optional executionTime: null | ITimestamp

WorkflowExecutionInfo executionTime

firstRunId​

• Optional firstRunId: null | string

The first run ID in the execution chain. Executions created via the following operations are considered to be in the same chain

  • ContinueAsNew
  • Workflow Retry
  • Workflow Reset
  • Cron Schedule

historyLength​

• Optional historyLength: null | Long

WorkflowExecutionInfo historyLength

historySizeBytes​

• Optional historySizeBytes: null | Long

WorkflowExecutionInfo historySizeBytes

inheritedBuildId​

• Optional inheritedBuildId: null | string

Build ID inherited from a previous/parent execution. If present, assigned_build_id will be set to this, instead of using the assignment rules.

memo​

• Optional memo: null | IMemo

WorkflowExecutionInfo memo

mostRecentWorkerVersionStamp​

• Optional mostRecentWorkerVersionStamp: null | IWorkerVersionStamp

If set, the most recent worker version stamp that appeared in a workflow task completion

parentExecution​

• Optional parentExecution: null | IWorkflowExecution

WorkflowExecutionInfo parentExecution

parentNamespaceId​

• Optional parentNamespaceId: null | string

WorkflowExecutionInfo parentNamespaceId

rootExecution​

• Optional rootExecution: null | IWorkflowExecution

Contains information about the root workflow execution. The root workflow execution is defined as follows:

  1. A workflow without parent workflow is its own root workflow.
  2. A workflow that has a parent workflow has the same root workflow as its parent workflow. Note: workflows continued as new or reseted may or may not have parents, check examples below.

Examples: Scenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3.

  • The root workflow of all three workflows is W1. Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3.
  • The root workflow of all three workflows is W1. Scenario 3: Workflow W1 continued as new W2.
  • The root workflow of W1 is W1 and the root workflow of W2 is W2. Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3
  • The root workflow of all three workflows is W1. Scenario 5: Workflow W1 is reseted, creating W2.
  • The root workflow of W1 is W1 and the root workflow of W2 is W2.

searchAttributes​

• Optional searchAttributes: null | ISearchAttributes

WorkflowExecutionInfo searchAttributes

startTime​

• Optional startTime: null | ITimestamp

WorkflowExecutionInfo startTime

stateTransitionCount​

• Optional stateTransitionCount: null | Long

WorkflowExecutionInfo stateTransitionCount

status​

• Optional status: null | WorkflowExecutionStatus

WorkflowExecutionInfo status

taskQueue​

• Optional taskQueue: null | string

WorkflowExecutionInfo taskQueue

type​

• Optional type: null | IWorkflowType

WorkflowExecutionInfo type