Skip to main content

Interface: $Properties

Properties of a WorkflowExecutionInfo.

Extended by​

Properties​

assignedBuildId?​

optional assignedBuildId?: string | null

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]

autoResetPoints?​

optional autoResetPoints?: $Properties | null

WorkflowExecutionInfo autoResetPoints

closeTime?​

optional closeTime?: $Properties | null

WorkflowExecutionInfo closeTime

execution?​

optional execution?: $Properties | null

WorkflowExecutionInfo execution

executionDuration?​

optional executionDuration?: $Properties | null

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?: $Properties | null

WorkflowExecutionInfo executionTime

externalPayloadCount?​

optional externalPayloadCount?: Long | null

Count of external payloads referenced in workflow history.

externalPayloadSizeBytes?​

optional externalPayloadSizeBytes?: Long | null

Total size in bytes of all external payloads referenced in workflow history.

firstRunId?​

optional firstRunId?: string | null

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?: Long | null

WorkflowExecutionInfo historyLength

historySizeBytes?​

optional historySizeBytes?: Long | null

WorkflowExecutionInfo historySizeBytes

inheritedBuildId?​

optional inheritedBuildId?: string | null

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]

memo?​

optional memo?: $Properties | null

WorkflowExecutionInfo memo

mostRecentWorkerVersionStamp?​

optional mostRecentWorkerVersionStamp?: $Properties | null

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]

parentExecution?​

optional parentExecution?: $Properties | null

WorkflowExecutionInfo parentExecution

parentNamespaceId?​

optional parentNamespaceId?: string | null

WorkflowExecutionInfo parentNamespaceId

priority?​

optional priority?: $Properties | null

Priority metadata

rootExecution?​

optional rootExecution?: $Properties | null

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?: $Properties | null

WorkflowExecutionInfo searchAttributes

startTime?​

optional startTime?: $Properties | null

WorkflowExecutionInfo startTime

stateTransitionCount?​

optional stateTransitionCount?: Long | null

WorkflowExecutionInfo stateTransitionCount

status?​

optional status?: WorkflowExecutionStatus | null

WorkflowExecutionInfo status

taskQueue?​

optional taskQueue?: string | null

WorkflowExecutionInfo taskQueue

type?​

optional type?: $Properties | null

WorkflowExecutionInfo type

versioningInfo?​

optional versioningInfo?: $Properties | null

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.

workerDeploymentName?​

optional workerDeploymentName?: string | null

The name of Worker Deployment that completed the most recent workflow task.