Interface: $Properties

Properties of a PauseWorkflowExecutionRequest.

Extended by

• IPauseWorkflowExecutionRequest

Properties

identity?

optional identity?: string | null

The identity of the client who initiated this request.

---

namespace?

optional namespace?: string | null

Namespace of the workflow to pause.

---

reason?

optional reason?: string | null

Reason to pause the workflow execution.

---

requestId?

optional requestId?: string | null

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

---

runId?

optional runId?: string | null

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?: string | null

ID of the workflow execution to be paused. Required.