Skip to main content

Interface: ActivityOptionsUpdate

Experimental

Specifies activity options to change in ActivityHandle.updateOptions operation.

If a field is assigned non-null value, the option will be set to that value. If a field is explicitly assigned null, the option will be cleared. If a field is undefined, the option will be left unchanged.

Activity Operator Commands are experimental. APIs may be subject to change.

Properties​

heartbeatTimeout?​

optional heartbeatTimeout?: Duration | null

Experimental

If set, specifies maximum time between successful heartbeats.

priority?​

optional priority?: Priority | null

Experimental

Priority to use when starting this activity.

retry?​

optional retry?: RetryPolicy | null

Experimental

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

scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: Duration | null

Experimental

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 | null

Experimental

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 | null

Experimental

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

startToCloseTimeout?​

optional startToCloseTimeout?: Duration | null

Experimental

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.

taskQueue?​

optional taskQueue?: string

Experimental

Task queue to run this activity on.