Skip to main content

Interface: $Properties

v1.PauseActivityRequest.$Properties

Properties of a PauseActivityRequest.

Hierarchy​

Properties​

activity​

• Optional activity: "id" | "type"

either activity id or activity type must be provided

execution​

• Optional execution: null | $Properties

Execution info of the workflow which scheduled this activity

id​

• Optional id: null | string

Only the activity with this ID will be paused.

identity​

• Optional identity: null | string

The identity of the client who initiated this request.

namespace​

• Optional namespace: null | string

Namespace of the workflow which scheduled this activity.

reason​

• Optional reason: null | string

Reason to pause the activity.

requestId​

• Optional requestId: null | string

Used to de-dupe pause requests.

type​

• Optional type: null | string

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