Skip to main content

Interface: $Properties

Properties of a ResetActivityExecutionRequest.

Extended by​

Properties​

activityId?​

optional activityId?: string | null

The ID of the activity to target.

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

namespace?​

optional namespace?: string | null

Namespace of the workflow which scheduled this activity.

requestId?​

optional requestId?: string | null

Used to de-dupe reset requests.

resetHeartbeat?​

optional resetHeartbeat?: boolean | null

Reset persisted heartbeat details. Reset always resets the attempt counter. Passing this flag causes reset to additionally discard any persisted heartbeat details.

resourceId?​

optional resourceId?: string | null

Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.

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.

runId?​

optional runId?: string | null

Run ID of the workflow or standalone activity. If empty, targets the latest run.

workflowId?​

optional workflowId?: string | null

If provided, targets a workflow activity for the given workflow ID. If empty, targets a standalone activity.