Skip to main content

Interface: RunOptions<In>

Options of ctx.run.

Type Parameters​

In​

In

Properties​

args​

args: In


cancellationType?​

optional cancellationType?: "WAIT_CANCELLATION_COMPLETED" | "TRY_CANCEL" | "ABANDON"


connection?​

optional connection?: string

Connection name, resolved by the service at SCHEDULE_ACTIVITY.


fairnessKey?​

optional fairnessKey?: string

Fairness within the queue (11 §2.11); default the workspace id.


fairnessWeight?​

optional fairnessWeight?: number

0.1 to 10; default 1.


headers?​

optional headers?: Headers


heartbeatTimeout?​

optional heartbeatTimeout?: Duration


nodeVersion?​

optional nodeVersion?: string

Overrides the node version the descriptor carries.


operation?​

optional operation?: string

Overrides the operation name the descriptor carries.


priority?​

optional priority?: number

1 (highest) to 5; default 3.


retry?​

optional retry?: Partial<RetryPolicy>

Default: 1 s, x2, at most 100 s, unlimited attempts (Temporal's policy).


runOn?​

optional runOn?: string


scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: Duration


scheduleToStartTimeout?​

optional scheduleToStartTimeout?: Duration


startToCloseTimeout?​

optional startToCloseTimeout?: Duration


summary?​

optional summary?: string

Label in the History tab (at most 200 characters).