Skip to main content

Interface: IRequestCancelExternalWorkflowExecutionCommandAttributes

command.v1.IRequestCancelExternalWorkflowExecutionCommandAttributes

Properties of a RequestCancelExternalWorkflowExecutionCommandAttributes.

Hierarchy

  • $Properties

    IRequestCancelExternalWorkflowExecutionCommandAttributes

Properties

childWorkflowOnly

Optional childWorkflowOnly: null | boolean

Set this to true if the workflow being cancelled is a child of the workflow originating this command. The request will be rejected if it is set to true and the target workflow is not a child of the requesting workflow.

Inherited from

$Properties.childWorkflowOnly


control

Optional control: null | string

Deprecated.

Inherited from

$Properties.control


namespace

Optional namespace: null | string

Deprecated. Cross-namespace operations are disabled by default as of server 1.30.1.

Inherited from

$Properties.namespace


reason

Optional reason: null | string

Reason for requesting the cancellation

Inherited from

$Properties.reason


runId

Optional runId: null | string

RequestCancelExternalWorkflowExecutionCommandAttributes runId

Inherited from

$Properties.runId


workflowId

Optional workflowId: null | string

RequestCancelExternalWorkflowExecutionCommandAttributes workflowId

Inherited from

$Properties.workflowId