Skip to main content

Interface: $Properties

Properties of a PauseActivityRequest.

Extended by​

Properties​

activity?​

optional activity?: "id" | "type"

either activity id or activity type must be provided

execution?​

optional execution?: $Properties | null

Execution info of the workflow which scheduled this activity

id?​

optional id?: string | null

Only the activity with this ID will be paused.

identity?​

optional identity?: string | null

The identity of the client who initiated this request.

namespace?​

optional namespace?: string | null

Namespace of the workflow which scheduled this activity.

reason?​

optional reason?: string | null

Reason to pause the activity.

requestId?​

optional requestId?: string | null

Used to de-dupe pause requests.

type?​

optional type?: string | null

Pause all running activities of this type. Note: Experimental - the behavior of pause by activity type might change in a future release.