Skip to main content

Interface: IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes

history.v1.IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes

Properties of a RequestCancelExternalWorkflowExecutionInitiatedEventAttributes.

Hierarchy​

  • $Properties

    ↳ IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes

Properties​

childWorkflowOnly​

• Optional childWorkflowOnly: null | boolean

Workers are expected to set this to true if the workflow they are requesting to cancel is a child of the workflow which issued the request

Inherited from​

$Properties.childWorkflowOnly

control​

• Optional control: null | string

Deprecated.

Inherited from​

$Properties.control

namespace​

• Optional namespace: null | string

The namespace the workflow to be cancelled lives in. SDKs and UI tools should use namespace field but server must use namespace_id only.

Inherited from​

$Properties.namespace

namespaceId​

• Optional namespaceId: null | string

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes namespaceId

Inherited from​

$Properties.namespaceId

reason​

• Optional reason: null | string

Reason for requesting the cancellation

Inherited from​

$Properties.reason

workflowExecution​

• Optional workflowExecution: null | $Properties

RequestCancelExternalWorkflowExecutionInitiatedEventAttributes workflowExecution

Inherited from​

$Properties.workflowExecution

workflowTaskCompletedEventId​

• Optional workflowTaskCompletedEventId: null | Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Inherited from​

$Properties.workflowTaskCompletedEventId