Skip to main content

Interface: IPauseActivityRequest

workflowservice.v1.IPauseActivityRequest

Properties of a PauseActivityRequest.

Hierarchy​

Properties​

activity​

• Optional activity: "id" | "type"

either activity id or activity type must be provided

Inherited from​

$Properties.activity


execution​

• Optional execution: null | $Properties

Execution info of the workflow which scheduled this activity

Inherited from​

$Properties.execution


id​

• Optional id: null | string

Only the activity with this ID will be paused.

Inherited from​

$Properties.id


identity​

• Optional identity: null | string

The identity of the client who initiated this request.

Inherited from​

$Properties.identity


namespace​

• Optional namespace: null | string

Namespace of the workflow which scheduled this activity.

Inherited from​

$Properties.namespace


reason​

• Optional reason: null | string

Reason to pause the activity.

Inherited from​

$Properties.reason


requestId​

• Optional requestId: null | string

Used to de-dupe pause requests.

Inherited from​

$Properties.requestId


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.

Inherited from​

$Properties.type