Skip to main content

Interface: IPauseActivityRequest

Properties of a PauseActivityRequest.

Extends​

Properties​

activity?​

optional activity?: "id" | "type"

either activity id or activity type must be provided

Inherited from​

$Properties.activity

execution?​

optional execution?: $Properties | null

Execution info of the workflow which scheduled this activity

Inherited from​

$Properties.execution

id?​

optional id?: string | null

Only the activity with this ID will be paused.

Inherited from​

$Properties.id

identity?​

optional identity?: string | null

The identity of the client who initiated this request.

Inherited from​

$Properties.identity

namespace?​

optional namespace?: string | null

Namespace of the workflow which scheduled this activity.

Inherited from​

$Properties.namespace

reason?​

optional reason?: string | null

Reason to pause the activity.

Inherited from​

$Properties.reason

requestId?​

optional requestId?: string | null

Used to de-dupe pause requests.

Inherited from​

$Properties.requestId

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.

Inherited from​

$Properties.type