Interface: IWorkflowExecutionInfo
workflow.v1.IWorkflowExecutionInfo
Properties of a WorkflowExecutionInfo.
Hierarchy
-
↳
IWorkflowExecutionInfo
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. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
Inherited from
autoResetPoints
• Optional autoResetPoints: null | $Properties
WorkflowExecutionInfo autoResetPoints
Inherited from
closeTime
• Optional closeTime: null | $Properties
WorkflowExecutionInfo closeTime
Inherited from
execution
• Optional execution: null | $Properties
WorkflowExecutionInfo execution
Inherited from
executionDuration
• Optional executionDuration: null | $Properties
Workflow execution duration is defined as difference between close time and execution time. This field is only populated if the workflow is closed.
Inherited from
executionTime
• Optional executionTime: null | $Properties
WorkflowExecutionInfo executionTime
Inherited from
externalPayloadCount
• Optional externalPayloadCount: null | Long
Count of external payloads referenced in workflow history.
Inherited from
$Properties.externalPayloadCount
externalPayloadSizeBytes
• Optional externalPayloadSizeBytes: null | Long
Total size in bytes of all external payloads referenced in workflow history.
Inherited from
$Properties.externalPayloadSizeBytes
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
Inherited from
historyLength
• Optional historyLength: null | Long
WorkflowExecutionInfo historyLength
Inherited from
historySizeBytes
• Optional historySizeBytes: null | Long
WorkflowExecutionInfo historySizeBytes
Inherited from
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. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
Inherited from
memo
• Optional memo: null | $Properties
WorkflowExecutionInfo memo
Inherited from
mostRecentWorkerVersionStamp
• Optional mostRecentWorkerVersionStamp: null | $Properties
If set, the most recent worker version stamp that appeared in a workflow task completion Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
Inherited from
$Properties.mostRecentWorkerVersionStamp
parentExecution
• Optional parentExecution: null | $Properties
WorkflowExecutionInfo parentExecution
Inherited from
parentNamespaceId
• Optional parentNamespaceId: null | string
WorkflowExecutionInfo parentNamespaceId
Inherited from
priority
• Optional priority: null | $Properties
Priority metadata
Inherited from
rootExecution
• Optional rootExecution: null | $Properties
Contains information about the root workflow execution. The root workflow execution is defined as follows:
- A workflow without parent workflow is its own root workflow.
- 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.
Inherited from
searchAttributes
• Optional searchAttributes: null | $Properties
WorkflowExecutionInfo searchAttributes
Inherited from
startTime
• Optional startTime: null | $Properties
WorkflowExecutionInfo startTime
Inherited from
stateTransitionCount
• Optional stateTransitionCount: null | Long
WorkflowExecutionInfo stateTransitionCount
Inherited from
$Properties.stateTransitionCount
status
• Optional status: null | WorkflowExecutionStatus
WorkflowExecutionInfo status
Inherited from
taskQueue
• Optional taskQueue: null | string
WorkflowExecutionInfo taskQueue
Inherited from
type
• Optional type: null | $Properties
WorkflowExecutionInfo type
Inherited from
versioningInfo
• Optional versioningInfo: null | $Properties
Absent value means the workflow execution is not versioned. When present, the execution might
be versioned or unversioned, depending on versioning_info.behavior and versioning_info.versioning_override.
Experimental. Versioning info is experimental and might change in the future.
Inherited from
workerDeploymentName
• Optional workerDeploymentName: null | string
The name of Worker Deployment that completed the most recent workflow task.