Class: WorkflowExecutionInfo

Hold basic information about a workflow execution. This structure is a part of visibility, and thus contain a limited subset of information.

Properties

assignedBuildId

assignedBuildId: 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]

---

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

externalPayloadCount: Long

Count of external payloads referenced in workflow history.

---

externalPayloadSizeBytes

externalPayloadSizeBytes: Long

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

---

firstRunId

firstRunId: 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

historyLength: Long

WorkflowExecutionInfo historyLength.

---

historySizeBytes

historySizeBytes: Long

WorkflowExecutionInfo historySizeBytes.

---

inheritedBuildId

inheritedBuildId: 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]

---

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

parentNamespaceId: string

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

stateTransitionCount: Long

WorkflowExecutionInfo stateTransitionCount.

---

status

status: WorkflowExecutionStatus

WorkflowExecutionInfo status.

---

taskQueue

taskQueue: string

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

workerDeploymentName: string

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

Methods

toJSON()

toJSON(): object

Converts this WorkflowExecutionInfo to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): WorkflowExecutionInfo & $Shape

Creates a new WorkflowExecutionInfo instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

WorkflowExecutionInfo & $Shape

WorkflowExecutionInfo instance

Call Signature

static create(properties?): WorkflowExecutionInfo

Creates a new WorkflowExecutionInfo instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

WorkflowExecutionInfo

WorkflowExecutionInfo instance

---

decode()

static decode(reader, length?): WorkflowExecutionInfo & $Shape

Decodes a WorkflowExecutionInfo message from the specified reader or buffer.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?

number

Message length if known beforehand

Returns

WorkflowExecutionInfo & $Shape

WorkflowExecutionInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): WorkflowExecutionInfo & $Shape

Decodes a WorkflowExecutionInfo message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

WorkflowExecutionInfo & $Shape

WorkflowExecutionInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Encodes the specified WorkflowExecutionInfo message. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionInfo.verify|verify messages.

Parameters

message

$Properties

WorkflowExecutionInfo message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified WorkflowExecutionInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionInfo.verify|verify messages.

Parameters

message

$Properties

WorkflowExecutionInfo message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): WorkflowExecutionInfo

Creates a WorkflowExecutionInfo message from a plain object. Also converts values to their respective internal types.

Parameters

object

Plain object

Returns

WorkflowExecutionInfo

WorkflowExecutionInfo

---

toObject()

static toObject(message, options?): object

Creates a plain object from a WorkflowExecutionInfo message. Also converts values to other types if specified.

Parameters

message

WorkflowExecutionInfo

WorkflowExecutionInfo

options?

IConversionOptions

Conversion options

Returns

object

Plain object