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 retried 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

eagerExecutionAccepted​

• Optional eagerExecutionAccepted: null | boolean

A boolean indicating whether the SDK has asked to eagerly execute the first workflow task for this workflow and eager execution was accepted by the server. Only populated by server with version >= 1.29.0.

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. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

inheritedPinnedVersion​

• Optional inheritedPinnedVersion: null | IWorkerDeploymentVersion

If present, the new workflow should start on this version with pinned base behavior. Child of pinned parent will inherit the parent's version if the Child's Task Queue belongs to that version.

New run initiated by workflow ContinueAsNew of pinned run, will inherit the previous run's version if the new run's Task Queue belongs to that version.

New run initiated by workflow Cron will never inherit.

New run initiated by workflow Retry will only inherit if the retried run is effectively pinned at the time of retry, and the retried run inherited a pinned version when it started (ie. it is a child of a pinned parent, or a CaN of a pinned run, and is running on a Task Queue in the inherited version).

Pinned override is inherited if Task Queue of new run is compatible with the override version. Override is inherited separately and takes precedence over inherited base version.

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

parentPinnedWorkerDeploymentVersion​

• Optional parentPinnedWorkerDeploymentVersion: null | 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. Deprecated. Use parent_versioning_info.

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

priority​

• Optional priority: null | IPriority

Priority metadata

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. When the workflow is its own root workflow, then root_workflow_execution is nil. 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.
  • W1 has root_workflow_execution set to nil.
  • W2 and W3 have root_workflow_execution set to W1. Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3.
  • The root workflow of all three workflows is W1.
  • W1 has root_workflow_execution set to nil.
  • W2 and W3 have root_workflow_execution set to W1. Scenario 3: Workflow W1 continued as new W2.
  • The root workflow of W1 is W1 and the root workflow of W2 is W2.
  • W1 and W2 have root_workflow_execution set to nil. Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3
  • The root workflow of all three workflows is W1.
  • W1 has root_workflow_execution set to nil.
  • W2 and W3 have root_workflow_execution set to W1. Scenario 5: Workflow W1 is reseted, creating W2.
  • The root workflow of W1 is W1 and the root workflow of W2 is W2.
  • W1 and W2 have root_workflow_execution set to nil.

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. [cleanup-experimental-wv]

taskQueue​

• Optional taskQueue: null | ITaskQueue

WorkflowExecutionStartedEventAttributes taskQueue

versioningOverride​

• Optional versioningOverride: null | IVersioningOverride

Versioning override applied to this workflow when it was started. Children, crons, retries, and continue-as-new will inherit source run's override if pinned and if the new workflow's Task Queue belongs to the override version.

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