Class: WorkflowExecutionInfo

workflow.v1.WorkflowExecutionInfo

Represents a WorkflowExecutionInfo.

Implements

• IWorkflowExecutionInfo

Constructors

constructor

• new WorkflowExecutionInfo(properties?): WorkflowExecutionInfo

Constructs a new WorkflowExecutionInfo.

Parameters

Name	Type	Description
properties?	IWorkflowExecutionInfo	Properties to set

Returns

WorkflowExecutionInfo

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.

Implementation of

IWorkflowExecutionInfo.assignedBuildId

---

autoResetPoints

• Optional autoResetPoints: null | IResetPoints

WorkflowExecutionInfo autoResetPoints.

Implementation of

IWorkflowExecutionInfo.autoResetPoints

---

closeTime

• Optional closeTime: null | ITimestamp

WorkflowExecutionInfo closeTime.

Implementation of

IWorkflowExecutionInfo.closeTime

---

execution

• Optional execution: null | IWorkflowExecution

WorkflowExecutionInfo execution.

Implementation of

IWorkflowExecutionInfo.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.

Implementation of

IWorkflowExecutionInfo.executionDuration

---

executionTime

• Optional executionTime: null | ITimestamp

WorkflowExecutionInfo executionTime.

Implementation of

IWorkflowExecutionInfo.executionTime

---

historyLength

• historyLength: Long

WorkflowExecutionInfo historyLength.

Implementation of

IWorkflowExecutionInfo.historyLength

---

historySizeBytes

• historySizeBytes: Long

WorkflowExecutionInfo historySizeBytes.

Implementation of

IWorkflowExecutionInfo.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.

Implementation of

IWorkflowExecutionInfo.inheritedBuildId

---

memo

• Optional memo: null | IMemo

WorkflowExecutionInfo memo.

Implementation of

IWorkflowExecutionInfo.memo

---

mostRecentWorkerVersionStamp

• Optional mostRecentWorkerVersionStamp: null | IWorkerVersionStamp

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

Implementation of

IWorkflowExecutionInfo.mostRecentWorkerVersionStamp

---

parentExecution

• Optional parentExecution: null | IWorkflowExecution

WorkflowExecutionInfo parentExecution.

Implementation of

IWorkflowExecutionInfo.parentExecution

---

parentNamespaceId

• parentNamespaceId: string

WorkflowExecutionInfo parentNamespaceId.

Implementation of

IWorkflowExecutionInfo.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.

Implementation of

IWorkflowExecutionInfo.rootExecution

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

WorkflowExecutionInfo searchAttributes.

Implementation of

IWorkflowExecutionInfo.searchAttributes

---

startTime

• Optional startTime: null | ITimestamp

WorkflowExecutionInfo startTime.

Implementation of

IWorkflowExecutionInfo.startTime

---

stateTransitionCount

• stateTransitionCount: Long

WorkflowExecutionInfo stateTransitionCount.

Implementation of

IWorkflowExecutionInfo.stateTransitionCount

---

status

• status: WorkflowExecutionStatus

WorkflowExecutionInfo status.

Implementation of

IWorkflowExecutionInfo.status

---

taskQueue

• taskQueue: string

WorkflowExecutionInfo taskQueue.

Implementation of

IWorkflowExecutionInfo.taskQueue

---

type

• Optional type: null | IWorkflowType

WorkflowExecutionInfo type.

Implementation of

IWorkflowExecutionInfo.type

Methods

toJSON

▸ toJSON(): Object

Converts this WorkflowExecutionInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkflowExecutionInfo

Creates a new WorkflowExecutionInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IWorkflowExecutionInfo	Properties to set

Returns

WorkflowExecutionInfo

WorkflowExecutionInfo instance

---

decode

▸ decode(reader, length?): WorkflowExecutionInfo

Decodes a WorkflowExecutionInfo message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

WorkflowExecutionInfo

WorkflowExecutionInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkflowExecutionInfo

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

WorkflowExecutionInfo

WorkflowExecutionInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkflowExecutionInfo	WorkflowExecutionInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkflowExecutionInfo	WorkflowExecutionInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): WorkflowExecutionInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

WorkflowExecutionInfo

WorkflowExecutionInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowExecutionInfo

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	WorkflowExecutionInfo	WorkflowExecutionInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object