Skip to main content

Interface: IResetActivityRequest

workflowservice.v1.IResetActivityRequest

Properties of a ResetActivityRequest.

Hierarchy

Properties

activity

Optional activity: "id" | "type" | "matchAll"

either activity id, activity type or update_all must be provided

Inherited from

$Properties.activity


execution

Optional execution: null | $Properties

Execution info of the workflow which scheduled this activity

Inherited from

$Properties.execution


id

Optional id: null | string

Only activity with this ID will be reset.

Inherited from

$Properties.id


identity

Optional identity: null | string

The identity of the client who initiated this request.

Inherited from

$Properties.identity


jitter

Optional jitter: null | $Properties

If set, and activity is in backoff, the activity will start at a random time within the specified jitter duration. (unless it is paused and keep_paused is set)

Inherited from

$Properties.jitter


keepPaused

Optional keepPaused: null | boolean

If activity is paused, it will remain paused after reset

Inherited from

$Properties.keepPaused


matchAll

Optional matchAll: null | boolean

Reset all running activities.

Inherited from

$Properties.matchAll


namespace

Optional namespace: null | string

Namespace of the workflow which scheduled this activity.

Inherited from

$Properties.namespace


resetHeartbeat

Optional resetHeartbeat: null | boolean

Indicates that activity should reset heartbeat details. This flag will be applied only to the new instance of the activity.

Inherited from

$Properties.resetHeartbeat


restoreOriginalOptions

Optional restoreOriginalOptions: null | boolean

If set, the activity options will be restored to the defaults. Default options are then options activity was created with. They are part of the first schedule event.

Inherited from

$Properties.restoreOriginalOptions


type

Optional type: null | string

Reset all running activities with of this type.

Inherited from

$Properties.type