Skip to main content

Interface: ScheduleUserActivityCommand

A user activity (ctx.activity, C-CMD-C): a function a self-hosted worker polling taskQueue implements. It has no node type, operation or runOn.

Extends​

  • ScheduleActivityBase

Properties​

activityId​

activityId: string

Inherited from​

ScheduleActivityBase.activityId


activityName​

activityName: string


args​

args: Json

Inherited from​

ScheduleActivityBase.args


cancellationType?​

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

Inherited from​

ScheduleActivityBase.cancellationType


connections?​

optional connections?: string[]

Connection names the worker may resolve per attempt (H2), at most 16.


fairnessKey?​

optional fairnessKey?: string

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

Inherited from​

ScheduleActivityBase.fairnessKey


fairnessWeight?​

optional fairnessWeight?: number

0.1 to 10; default 1.

Inherited from​

ScheduleActivityBase.fairnessWeight


headers?​

optional headers?: Headers

Inherited from​

ScheduleActivityBase.headers


heartbeatTimeout?​

optional heartbeatTimeout?: number

Inherited from​

ScheduleActivityBase.heartbeatTimeout


kind​

kind: "user"


priority?​

optional priority?: number

Inherited from​

ScheduleActivityBase.priority


retry​

retry: RetryPolicy

Inherited from​

ScheduleActivityBase.retry


scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: number

Inherited from​

ScheduleActivityBase.scheduleToCloseTimeout


scheduleToStartTimeout?​

optional scheduleToStartTimeout?: number

Inherited from​

ScheduleActivityBase.scheduleToStartTimeout


startToCloseTimeout?​

optional startToCloseTimeout?: number

Inherited from​

ScheduleActivityBase.startToCloseTimeout


summary?​

optional summary?: string

Inherited from​

ScheduleActivityBase.summary


taskQueue​

taskQueue: string


type​

type: "SCHEDULE_ACTIVITY"

Inherited from​

ScheduleActivityBase.type