Skip to main content

Interface: StartOptions

Properties​

details?​

optional details?: string


executionTimeout?​

optional executionTimeout?: Duration

Bounds the whole chain; default the declaration's executionTimeout.


fairnessKey?​

optional fairnessKey?: string

Fairness of the run's tasks.


fairnessWeight?​

optional fairnessWeight?: number


headers?​

optional headers?: Headers

Headers of the start (WORKFLOW_STARTED.headers, interceptors).


idConflictPolicy?​

optional idConflictPolicy?: "FAIL" | "USE_EXISTING" | "TERMINATE_EXISTING"

Default FAIL.


idReusePolicy?​

optional idReusePolicy?: "ALLOW_DUPLICATE" | "ALLOW_DUPLICATE_FAILED_ONLY" | "REJECT_DUPLICATE"

Default ALLOW_DUPLICATE.


info?​

optional info?: Partial<WorkflowInfoSnapshot>


input?​

optional input?: unknown


memo?​

optional memo?: JsonObject

The run's memo (ctx.info.context).


retry?​

optional retry?: WorkflowRetryOptions

Run-level retry; default the declaration's retry.


runId?​

optional runId?: string


runTimeout?​

optional runTimeout?: Duration

Bounds one run; default the declaration's runTimeout.


searchAttributes?​

optional searchAttributes?: JsonObject

Search attributes at the start.


signals?​

optional signals?: object[]

Signals delivered right after the start (signal-with-start).

name​

name: string

payload?​

optional payload?: unknown


startDelay?​

optional startDelay?: Duration

Delay the first workflow task (11 §2.23); a signal ends the delay.


summary?​

optional summary?: string


taskQueue?​

optional taskQueue?: string

The task queue the run starts on; default the declaration's, else managed.


update?​

optional update?: object

Update-with-start (11 §2.6): admitted right after WORKFLOW_STARTED.

args?​

optional args?: unknown

headers?​

optional headers?: Headers

name​

name: string

updateId?​

optional updateId?: string


versioningBehavior?​

optional versioningBehavior?: "PINNED" | "AUTO_UPGRADE"

Default the declaration's versioningBehavior.


workflowId?​

optional workflowId?: string

The business id (11 §2.1); unique among the open runs of the workflow key.


workflowKey?​

optional workflowKey?: string

The workflow key for workflow-id policies and targets; default the declaration's name.


workflowTaskTimeout?​

optional workflowTaskTimeout?: Duration

Recorded only; default the declaration's workflowTaskTimeout.