Skip to main content

Interface: $Properties

v1.RequestCancelWorkflowExecutionRequest.$Properties

Properties of a RequestCancelWorkflowExecutionRequest.

Hierarchy​

Properties​

firstExecutionRunId​

• Optional firstExecutionRunId: null | string

If set, this call will error if the most recent (if no run id is set on workflow_execution), or specified (if it is) workflow execution is not part of the same execution chain as this id.


identity​

• Optional identity: null | string

The identity of the worker/client


• Optional links: null | $Properties[]

Links to be associated with the WorkflowExecutionCanceled event.


namespace​

• Optional namespace: null | string

RequestCancelWorkflowExecutionRequest namespace


reason​

• Optional reason: null | string

Reason for requesting the cancellation


requestId​

• Optional requestId: null | string

Used to de-dupe cancellation requests


workflowExecution​

• Optional workflowExecution: null | $Properties

RequestCancelWorkflowExecutionRequest workflowExecution