Class: WorkflowExecutionStartedEventAttributes

history.v1.WorkflowExecutionStartedEventAttributes

Always the first event in workflow history

Implements

• IWorkflowExecutionStartedEventAttributes

Constructors

constructor

• new WorkflowExecutionStartedEventAttributes(properties?): WorkflowExecutionStartedEventAttributes

Constructs a new WorkflowExecutionStartedEventAttributes.

Parameters

Name	Type	Description
properties?	IWorkflowExecutionStartedEventAttributes	Properties to set

Returns

WorkflowExecutionStartedEventAttributes

Properties

attempt

• attempt: number

Starting at 1, the number of times we have tried to execute this workflow

Implementation of

IWorkflowExecutionStartedEventAttributes.attempt

---

completionCallbacks

• completionCallbacks: ICallback[]

Completion callbacks attached when this workflow was started.

Implementation of

IWorkflowExecutionStartedEventAttributes.completionCallbacks

---

continuedExecutionRunId

• continuedExecutionRunId: string

Run id of the previous workflow which continued-as-new or retired or cron executed into this workflow.

Implementation of

IWorkflowExecutionStartedEventAttributes.continuedExecutionRunId

---

continuedFailure

• Optional continuedFailure: null | IFailure

WorkflowExecutionStartedEventAttributes continuedFailure.

Implementation of

IWorkflowExecutionStartedEventAttributes.continuedFailure

---

cronSchedule

• cronSchedule: string

If this workflow runs on a cron schedule, it will appear here

Implementation of

IWorkflowExecutionStartedEventAttributes.cronSchedule

---

firstExecutionRunId

• firstExecutionRunId: string

This is the very first runId along the chain of ContinueAsNew, Retry, Cron and Reset. Used to identify a chain.

Implementation of

IWorkflowExecutionStartedEventAttributes.firstExecutionRunId

---

firstWorkflowTaskBackoff

• Optional firstWorkflowTaskBackoff: null | IDuration

For a cron workflow, this contains the amount of time between when this iteration of the cron workflow was scheduled and when it should run next per its cron_schedule.

Implementation of

IWorkflowExecutionStartedEventAttributes.firstWorkflowTaskBackoff

---

header

• Optional header: null | IHeader

WorkflowExecutionStartedEventAttributes header.

Implementation of

IWorkflowExecutionStartedEventAttributes.header

---

identity

• identity: string

Identity of the client who requested this execution

Implementation of

IWorkflowExecutionStartedEventAttributes.identity

---

inheritedBuildId

• inheritedBuildId: string

When present, this execution is assigned to the build ID of its parent or previous execution. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

Implementation of

IWorkflowExecutionStartedEventAttributes.inheritedBuildId

---

initiator

• initiator: ContinueAsNewInitiator

WorkflowExecutionStartedEventAttributes initiator.

Implementation of

IWorkflowExecutionStartedEventAttributes.initiator

---

input

• Optional input: null | IPayloads

SDK will deserialize this and provide it as arguments to the workflow function

Implementation of

IWorkflowExecutionStartedEventAttributes.input

---

lastCompletionResult

• Optional lastCompletionResult: null | IPayloads

WorkflowExecutionStartedEventAttributes lastCompletionResult.

Implementation of

IWorkflowExecutionStartedEventAttributes.lastCompletionResult

---

memo

• Optional memo: null | IMemo

WorkflowExecutionStartedEventAttributes memo.

Implementation of

IWorkflowExecutionStartedEventAttributes.memo

---

originalExecutionRunId

• originalExecutionRunId: string

This is the run id when the WorkflowExecutionStarted event was written. A workflow reset changes the execution run_id, but preserves this field.

Implementation of

IWorkflowExecutionStartedEventAttributes.originalExecutionRunId

---

parentInitiatedEventId

• parentInitiatedEventId: Long

EventID of the child execution initiated event in parent workflow

Implementation of

IWorkflowExecutionStartedEventAttributes.parentInitiatedEventId

---

parentInitiatedEventVersion

• parentInitiatedEventVersion: Long

Version of the child execution initiated event in parent workflow It should be used together with parent_initiated_event_id to identify a child initiated event for global namespace

Implementation of

IWorkflowExecutionStartedEventAttributes.parentInitiatedEventVersion

---

parentPinnedWorkerDeploymentVersion

• parentPinnedWorkerDeploymentVersion: string

When present, it means this is a child workflow of a parent that is Pinned to this Worker Deployment Version. In this case, child workflow will start as Pinned to this Version instead of starting on the Current Version of its Task Queue. This is set only if the child workflow is starting on a Task Queue belonging to the same Worker Deployment Version.

Implementation of

IWorkflowExecutionStartedEventAttributes.parentPinnedWorkerDeploymentVersion

---

parentWorkflowExecution

• Optional parentWorkflowExecution: null | IWorkflowExecution

Contains information about parent workflow execution that initiated the child workflow these attributes belong to. If the workflow these attributes belong to is not a child workflow of any other execution, this field will not be populated.

Implementation of

IWorkflowExecutionStartedEventAttributes.parentWorkflowExecution

---

parentWorkflowNamespace

• parentWorkflowNamespace: string

If this workflow is a child, the namespace our parent lives in. SDKs and UI tools should use parent_workflow_namespace field but server must use parent_workflow_namespace_id only.

Implementation of

IWorkflowExecutionStartedEventAttributes.parentWorkflowNamespace

---

parentWorkflowNamespaceId

• parentWorkflowNamespaceId: string

WorkflowExecutionStartedEventAttributes parentWorkflowNamespaceId.

Implementation of

IWorkflowExecutionStartedEventAttributes.parentWorkflowNamespaceId

---

prevAutoResetPoints

• Optional prevAutoResetPoints: null | IResetPoints

WorkflowExecutionStartedEventAttributes prevAutoResetPoints.

Implementation of

IWorkflowExecutionStartedEventAttributes.prevAutoResetPoints

---

priority

• Optional priority: null | IPriority

Priority metadata

Implementation of

IWorkflowExecutionStartedEventAttributes.priority

---

retryPolicy

• Optional retryPolicy: null | IRetryPolicy

WorkflowExecutionStartedEventAttributes retryPolicy.

Implementation of

IWorkflowExecutionStartedEventAttributes.retryPolicy

---

rootWorkflowExecution

• Optional rootWorkflowExecution: 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

IWorkflowExecutionStartedEventAttributes.rootWorkflowExecution

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

WorkflowExecutionStartedEventAttributes searchAttributes.

Implementation of

IWorkflowExecutionStartedEventAttributes.searchAttributes

---

sourceVersionStamp

• Optional sourceVersionStamp: null | IWorkerVersionStamp

If this workflow intends to use anything other than the current overall default version for the queue, then we include it here. Deprecated. [cleanup-experimental-wv]

Implementation of

IWorkflowExecutionStartedEventAttributes.sourceVersionStamp

---

taskQueue

• Optional taskQueue: null | ITaskQueue

WorkflowExecutionStartedEventAttributes taskQueue.

Implementation of

IWorkflowExecutionStartedEventAttributes.taskQueue

---

versioningOverride

• Optional versioningOverride: null | IVersioningOverride

Versioning override applied to this workflow when it was started.

Implementation of

IWorkflowExecutionStartedEventAttributes.versioningOverride

---

workflowExecutionExpirationTime

• Optional workflowExecutionExpirationTime: null | ITimestamp

The absolute time at which the workflow will be timed out. This is passed without change to the next run/retry of a workflow.

Implementation of

IWorkflowExecutionStartedEventAttributes.workflowExecutionExpirationTime

---

workflowExecutionTimeout

• Optional workflowExecutionTimeout: null | IDuration

Total workflow execution timeout including retries and continue as new.

Implementation of

IWorkflowExecutionStartedEventAttributes.workflowExecutionTimeout

---

workflowId

• workflowId: string

This field is new in 1.21.

Implementation of

IWorkflowExecutionStartedEventAttributes.workflowId

---

workflowRunTimeout

• Optional workflowRunTimeout: null | IDuration

Timeout of a single workflow run.

Implementation of

IWorkflowExecutionStartedEventAttributes.workflowRunTimeout

---

workflowTaskTimeout

• Optional workflowTaskTimeout: null | IDuration

Timeout of a single workflow task.

Implementation of

IWorkflowExecutionStartedEventAttributes.workflowTaskTimeout

---

workflowType

• Optional workflowType: null | IWorkflowType

WorkflowExecutionStartedEventAttributes workflowType.

Implementation of

IWorkflowExecutionStartedEventAttributes.workflowType

Methods

toJSON

▸ toJSON(): Object

Converts this WorkflowExecutionStartedEventAttributes to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkflowExecutionStartedEventAttributes

Creates a new WorkflowExecutionStartedEventAttributes instance using the specified properties.

Parameters

Name	Type	Description
properties?	IWorkflowExecutionStartedEventAttributes	Properties to set

Returns

WorkflowExecutionStartedEventAttributes

WorkflowExecutionStartedEventAttributes instance

---

decode

▸ decode(reader, length?): WorkflowExecutionStartedEventAttributes

Decodes a WorkflowExecutionStartedEventAttributes 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

WorkflowExecutionStartedEventAttributes

WorkflowExecutionStartedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkflowExecutionStartedEventAttributes

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

Parameters

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

Returns

WorkflowExecutionStartedEventAttributes

WorkflowExecutionStartedEventAttributes

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 WorkflowExecutionStartedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.verify|verify messages.

Parameters

Name	Type	Description
message	IWorkflowExecutionStartedEventAttributes	WorkflowExecutionStartedEventAttributes message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkflowExecutionStartedEventAttributes	WorkflowExecutionStartedEventAttributes message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): WorkflowExecutionStartedEventAttributes

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

WorkflowExecutionStartedEventAttributes

WorkflowExecutionStartedEventAttributes

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowExecutionStartedEventAttributes

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 WorkflowExecutionStartedEventAttributes message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	WorkflowExecutionStartedEventAttributes	WorkflowExecutionStartedEventAttributes
options?	IConversionOptions	Conversion options

Returns

Object

Plain object