Skip to main content

Interface: IPauseWorkflowExecutionRequest

workflowservice.v1.IPauseWorkflowExecutionRequest

Properties of a PauseWorkflowExecutionRequest.

Hierarchy​

Properties​

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 to pause.

Inherited from​

$Properties.namespace

reason​

• Optional reason: null | string

Reason to pause the workflow execution.

Inherited from​

$Properties.reason

requestId​

• Optional requestId: null | string

A unique identifier for this pause request for idempotence. Typically UUIDv4.

Inherited from​

$Properties.requestId

runId​

• Optional runId: null | string

Run ID of the workflow execution to be paused. Optional. If not provided, the current run of the workflow will be paused.

Inherited from​

$Properties.runId

workflowId​

• Optional workflowId: null | string

ID of the workflow execution to be paused. Required.

Inherited from​

$Properties.workflowId