Interface: StartOptions
Properties
details?
optionaldetails?:string
executionTimeout?
optionalexecutionTimeout?:Duration
Bounds the whole chain; default the declaration's executionTimeout.
fairnessKey?
optionalfairnessKey?:string
Fairness of the run's tasks.
fairnessWeight?
optionalfairnessWeight?:number
headers?
optionalheaders?:Headers
Headers of the start (WORKFLOW_STARTED.headers, interceptors).
idConflictPolicy?
optionalidConflictPolicy?:"FAIL"|"USE_EXISTING"|"TERMINATE_EXISTING"
Default FAIL.
idReusePolicy?
optionalidReusePolicy?:"ALLOW_DUPLICATE"|"ALLOW_DUPLICATE_FAILED_ONLY"|"REJECT_DUPLICATE"
Default ALLOW_DUPLICATE.
info?
optionalinfo?:Partial<WorkflowInfoSnapshot>
input?
optionalinput?:unknown
memo?
optionalmemo?:JsonObject
The run's memo (ctx.info.context).
retry?
optionalretry?:WorkflowRetryOptions
Run-level retry; default the declaration's retry.
runId?
optionalrunId?:string
runTimeout?
optionalrunTimeout?:Duration
Bounds one run; default the declaration's runTimeout.
searchAttributes?
optionalsearchAttributes?:JsonObject
Search attributes at the start.
signals?
optionalsignals?:object[]
Signals delivered right after the start (signal-with-start).
name
name:
string
payload?
optionalpayload?:unknown
startDelay?
optionalstartDelay?:Duration
Delay the first workflow task (11 §2.23); a signal ends the delay.
summary?
optionalsummary?:string
taskQueue?
optionaltaskQueue?:string
The task queue the run starts on; default the declaration's, else managed.
update?
optionalupdate?:object
Update-with-start (11 §2.6): admitted right after WORKFLOW_STARTED.
args?
optionalargs?:unknown
headers?
optionalheaders?:Headers
name
name:
string
updateId?
optionalupdateId?:string
versioningBehavior?
optionalversioningBehavior?:"PINNED"|"AUTO_UPGRADE"
Default the declaration's versioningBehavior.
workflowId?
optionalworkflowId?:string
The business id (11 §2.1); unique among the open runs of the workflow key.
workflowKey?
optionalworkflowKey?:string
The workflow key for workflow-id policies and targets; default the declaration's name.
workflowTaskTimeout?
optionalworkflowTaskTimeout?:Duration
Recorded only; default the declaration's workflowTaskTimeout.