Skip to main content

Interface: IInitializeWorkflow

coresdk.workflow_activation.IInitializeWorkflow

Properties of an InitializeWorkflow.

Implemented by​

Properties​

arguments​

• Optional arguments: null | IPayload[]

Inputs to the workflow code

attempt​

• Optional attempt: null | number

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

continuedFailure​

• Optional continuedFailure: null | IFailure

If this workflow was a continuation and that continuation failed, the details of that.

continuedFromExecutionRunId​

• Optional continuedFromExecutionRunId: null | string

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

continuedInitiator​

• Optional continuedInitiator: null | ContinueAsNewInitiator

If this workflow was a continuation, indicates the type of continuation.

cronSchedule​

• Optional cronSchedule: null | string

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

cronScheduleToScheduleInterval​

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

firstExecutionRunId​

• Optional firstExecutionRunId: null | string

This is the very first run id the workflow ever had, following continuation chains.

headers​

• Optional headers: null | { [k: string]: IPayload; }

Used to add metadata e.g. for tracing and auth, meant to be read and written to by interceptors.

identity​

• Optional identity: null | string

Identity of the client who requested this execution

lastCompletionResult​

• Optional lastCompletionResult: null | IPayloads

If this workflow was a continuation and that continuation completed, the details of that.

memo​

• Optional memo: null | IMemo

User-defined memo

parentWorkflowInfo​

• Optional parentWorkflowInfo: null | INamespacedWorkflowExecution

If this workflow is a child, information about the parent

priority​

• Optional priority: null | IPriority

Priority of this workflow execution

randomnessSeed​

• Optional randomnessSeed: null | Long

The seed must be used to initialize the random generator used by SDK. RandomSeedUpdatedAttributes are used to deliver seed updates.

retryPolicy​

• Optional retryPolicy: null | IRetryPolicy

This workflow's retry policy

rootWorkflow​

• Optional rootWorkflow: null | IWorkflowExecution

Contains information about the root workflow execution. It is possible for the namespace to be different than this workflow if using OSS and cross-namespace children, but this information is not retained. Users should take care to track it by other means in such situations.

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.

See field in WorkflowExecutionStarted for more detail.

searchAttributes​

• Optional searchAttributes: null | ISearchAttributes

Search attributes created/updated when this workflow was started

startTime​

• Optional startTime: null | ITimestamp

When the workflow execution started event was first written

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

The workflow id used on the temporal server

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

The identifier the lang-specific sdk uses to execute workflow code