Skip to main content

Interface: $Properties

v1.PauseWorkflowExecutionRequest.$Properties

Properties of a PauseWorkflowExecutionRequest.

Hierarchy​

Properties​

identity​

• Optional identity: null | string

The identity of the client who initiated this request.

namespace​

• Optional namespace: null | string

Namespace of the workflow to pause.

reason​

• Optional reason: null | string

Reason to pause the workflow execution.

requestId​

• Optional requestId: null | string

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

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.

workflowId​

• Optional workflowId: null | string

ID of the workflow execution to be paused. Required.