Skip to main content

Interface: IPauseActivityExecutionRequest

workflowservice.v1.IPauseActivityExecutionRequest

Properties of a PauseActivityExecutionRequest.

Hierarchy

Properties

activityId

Optional activityId: null | string

The ID of the activity to target.

Inherited from

$Properties.activityId


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


resourceId

Optional resourceId: null | string

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

Inherited from

$Properties.resourceId


runId

Optional runId: null | string

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

Inherited from

$Properties.runId


workflowId

Optional workflowId: null | string

If provided, pause a workflow activity (or activities) for the given workflow ID. If empty, targets a standalone activity.

Inherited from

$Properties.workflowId