Skip to main content

Interface: ActivityOptions

client.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.

typeInfo​

• Optional typeInfo: PayloadTypeInfo

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

typedSearchAttributes​

• Optional typedSearchAttributes: TypedSearchAttributes | SearchAttributePair[]

Search attributes for the activity.