Skip to main content

Interface: ActivityOptions

Options used by ActivityClient.start.

Properties​

args?​

optional args?: any[] | readonly any[]

Input arguments to pass to the activity.

heartbeatTimeout?​

optional heartbeatTimeout?: Duration

If set, specifies maximum time between successful heartbeats.

id​

id: string

Activity ID of the started activity. It's recommended to use a meaningful business ID.

idConflictPolicy?​

optional idConflictPolicy?: ActivityIdConflictPolicy

Specifies behavior if there's a running activity with the same ID. Note that there can only be one running Activity for each Activity ID.

idReusePolicy?​

optional idReusePolicy?: ActivityIdReusePolicy

Specifies behavior if there's a closed activity with the same ID.

priority?​

optional priority?: Priority

Priority to use when starting this activity.

retry?​

optional retry?: RetryPolicy

Controls how Activity is retried. If not set, the server will assign default retry policy.

scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: Duration

If set, specifies maximum time for a single execution attempt. This timeout is retryable.

Note: it is required to set at least one of startToCloseTimeout and scheduleToCloseTimeout.

scheduleToStartTimeout?​

optional scheduleToStartTimeout?: Duration

If set, specifies maximum time the activity can wait in the task queue before being picked up by a worker. This timeout is non-retryable.

startDelay?​

optional startDelay?: Duration

Time to wait before dispatching the first activity task. This delay is not applied to retry attempts.

startToCloseTimeout?​

optional startToCloseTimeout?: Duration

Is set, specifies total time the activity is allowed to run, including retries.

Note: it is required to set at least one of startToCloseTimeout and scheduleToCloseTimeout.

summary?​

optional summary?: string

A single-line fixed summary for this activity execution that may appear in UI/CLI. This can be in single-line Temporal markdown format.

taskQueue​

taskQueue: string

Task queue to run this activity on.

typedSearchAttributes?​

optional typedSearchAttributes?: SearchAttributePair[] | TypedSearchAttributes

Search attributes for the activity.

typeInfo?​

optional typeInfo?: PayloadTypeInfo

Experimental

Type information used to encode Activity arguments and decode its result.