Skip to main content

Interface: ISignalExternalWorkflowExecutionInitiatedEventAttributes

history.v1.ISignalExternalWorkflowExecutionInitiatedEventAttributes

Properties of a SignalExternalWorkflowExecutionInitiatedEventAttributes.

Hierarchy​

  • $Properties

    ↳ ISignalExternalWorkflowExecutionInitiatedEventAttributes

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

• Optional header: null | $Properties

SignalExternalWorkflowExecutionInitiatedEventAttributes header

Inherited from​

$Properties.header

input​

• Optional input: null | $Properties

Serialized arguments to provide to the signal handler

Inherited from​

$Properties.input

namespace​

• Optional namespace: null | string

Namespace of the to-be-signalled workflow. SDKs and UI tools should use namespace field but server must use namespace_id only.

Inherited from​

$Properties.namespace

namespaceId​

• Optional namespaceId: null | string

SignalExternalWorkflowExecutionInitiatedEventAttributes namespaceId

Inherited from​

$Properties.namespaceId

signalName​

• Optional signalName: null | string

name/type of the signal to fire in the external workflow

Inherited from​

$Properties.signalName

workflowExecution​

• Optional workflowExecution: null | $Properties

SignalExternalWorkflowExecutionInitiatedEventAttributes 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