Skip to main content

Interface: $Properties

Properties of a ResetActivityRequest.

Extended by​

Properties​

activity?​

optional activity?: "id" | "type" | "matchAll"

either activity id, activity type or update_all must be provided

execution?​

optional execution?: $Properties | null

Execution info of the workflow which scheduled this activity

id?​

optional id?: string | null

Only activity with this ID will be reset.

identity?​

optional identity?: string | null

The identity of the client who initiated this request.

jitter?​

optional jitter?: $Properties | null

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)

keepPaused?​

optional keepPaused?: boolean | null

If activity is paused, it will remain paused after reset

matchAll?​

optional matchAll?: boolean | null

Reset all running activities.

namespace?​

optional namespace?: string | null

Namespace of the workflow which scheduled this activity.

resetHeartbeat?​

optional resetHeartbeat?: boolean | null

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

restoreOriginalOptions?​

optional restoreOriginalOptions?: boolean | null

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.

type?​

optional type?: string | null

Reset all running activities with of this type.