Skip to main content

Interface: ActivityOptionsUpdate

client.ActivityOptionsUpdate

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

If set, specifies maximum time between successful heartbeats.

priority​

• Optional priority: null | Priority

Priority to use when starting this activity.

retry​

• Optional retry: null | RetryPolicy

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

scheduleToCloseTimeout​

• Optional scheduleToCloseTimeout: null | 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: null | 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: null | Duration

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

startToCloseTimeout​

• Optional startToCloseTimeout: null | 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.

taskQueue​

• Optional taskQueue: string

Task queue to run this activity on.