Skip to main content

Interface: IWorkflowExecutionStartedEventAttributes

history.v1.IWorkflowExecutionStartedEventAttributes

Properties of a WorkflowExecutionStartedEventAttributes.

Implemented by​

Properties​

attempt​

• Optional attempt: null | number

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

completionCallbacks​

• Optional completionCallbacks: null | ICallback[]

Completion callbacks attached when this workflow was started.

continuedExecutionRunId​

• Optional continuedExecutionRunId: null | string

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

continuedFailure​

• Optional continuedFailure: null | IFailure

WorkflowExecutionStartedEventAttributes continuedFailure

cronSchedule​

• Optional cronSchedule: null | string

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

firstExecutionRunId​

• Optional firstExecutionRunId: null | string

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

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.

• Optional header: null | IHeader

WorkflowExecutionStartedEventAttributes header

identity​

• Optional identity: null | string

Identity of the client who requested this execution

inheritedBuildId​

• Optional inheritedBuildId: null | string

When present, this execution is assigned to the build ID of its parent or previous execution.

initiator​

• Optional initiator: null | ContinueAsNewInitiator

WorkflowExecutionStartedEventAttributes initiator

input​

• Optional input: null | IPayloads

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

lastCompletionResult​

• Optional lastCompletionResult: null | IPayloads

WorkflowExecutionStartedEventAttributes lastCompletionResult

memo​

• Optional memo: null | IMemo

WorkflowExecutionStartedEventAttributes memo

originalExecutionRunId​

• Optional originalExecutionRunId: null | string

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

parentInitiatedEventId​

• Optional parentInitiatedEventId: null | Long

EventID of the child execution initiated event in parent workflow

parentInitiatedEventVersion​

• Optional parentInitiatedEventVersion: null | 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

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.

parentWorkflowNamespace​

• Optional parentWorkflowNamespace: null | 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.

parentWorkflowNamespaceId​

• Optional parentWorkflowNamespaceId: null | string

WorkflowExecutionStartedEventAttributes parentWorkflowNamespaceId

prevAutoResetPoints​

• Optional prevAutoResetPoints: null | IResetPoints

WorkflowExecutionStartedEventAttributes prevAutoResetPoints

retryPolicy​

• Optional retryPolicy: null | IRetryPolicy

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

searchAttributes​

• Optional searchAttributes: null | ISearchAttributes

WorkflowExecutionStartedEventAttributes 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. use inherited_build_id instead

taskQueue​

• Optional taskQueue: null | ITaskQueue

WorkflowExecutionStartedEventAttributes taskQueue

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.

workflowExecutionTimeout​

• Optional workflowExecutionTimeout: null | IDuration

Total workflow execution timeout including retries and continue as new.

workflowId​

• Optional workflowId: null | string

This field is new in 1.21.

workflowRunTimeout​

• Optional workflowRunTimeout: null | IDuration

Timeout of a single workflow run.

workflowTaskTimeout​

• Optional workflowTaskTimeout: null | IDuration

Timeout of a single workflow task.

workflowType​

• Optional workflowType: null | IWorkflowType

WorkflowExecutionStartedEventAttributes workflowType