Skip to main content

Interface: IActivityOptions

activity.v1.IActivityOptions

Properties of an ActivityOptions.

Implemented by​

Properties​

heartbeatTimeout​

• Optional heartbeatTimeout: null | IDuration

Maximum permitted time between successful worker heartbeats.

retryPolicy​

• Optional retryPolicy: null | IRetryPolicy

ActivityOptions retryPolicy

scheduleToCloseTimeout​

• Optional scheduleToCloseTimeout: null | IDuration

Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. Either this or start_to_close_timeout must be specified.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

scheduleToStartTimeout​

• Optional scheduleToStartTimeout: null | IDuration

Limits time an activity task can stay in a task queue before a worker picks it up. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to schedule_to_close_timeout or workflow execution timeout if not specified.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

startToCloseTimeout​

• Optional startToCloseTimeout: null | IDuration

Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. Either this or schedule_to_close_timeout must be specified.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

taskQueue​

• Optional taskQueue: null | ITaskQueue

ActivityOptions taskQueue