Interface: ICommand
Properties of a Command.
Hierarchy
-
↳
ICommand
Properties
attributes
• Optional attributes: "scheduleActivityTaskCommandAttributes" | "startTimerCommandAttributes" | "completeWorkflowExecutionCommandAttributes" | "failWorkflowExecutionCommandAttributes" | "requestCancelActivityTaskCommandAttributes" | "cancelTimerCommandAttributes" | "cancelWorkflowExecutionCommandAttributes" | "requestCancelExternalWorkflowExecutionCommandAttributes" | "recordMarkerCommandAttributes" | "continueAsNewWorkflowExecutionCommandAttributes" | "startChildWorkflowExecutionCommandAttributes" | "signalExternalWorkflowExecutionCommandAttributes" | "upsertWorkflowSearchAttributesCommandAttributes" | "protocolMessageCommandAttributes" | "modifyWorkflowPropertiesCommandAttributes" | "scheduleNexusOperationCommandAttributes" | "requestCancelNexusOperationCommandAttributes"
The command details. The type must match that in command_type.
Inherited from
cancelTimerCommandAttributes
• Optional cancelTimerCommandAttributes: null | $Properties
Command cancelTimerCommandAttributes
Inherited from
$Properties.cancelTimerCommandAttributes
cancelWorkflowExecutionCommandAttributes
• Optional cancelWorkflowExecutionCommandAttributes: null | $Properties
Command cancelWorkflowExecutionCommandAttributes
Inherited from
$Properties.cancelWorkflowExecutionCommandAttributes
commandType
• Optional commandType: null | CommandType
Command commandType
Inherited from
completeWorkflowExecutionCommandAttributes
• Optional completeWorkflowExecutionCommandAttributes: null | $Properties
Command completeWorkflowExecutionCommandAttributes
Inherited from
$Properties.completeWorkflowExecutionCommandAttributes
continueAsNewWorkflowExecutionCommandAttributes
• Optional continueAsNewWorkflowExecutionCommandAttributes: null | $Properties
Command continueAsNewWorkflowExecutionCommandAttributes
Inherited from
$Properties.continueAsNewWorkflowExecutionCommandAttributes
eventGroupMarkers
• Optional eventGroupMarkers: null | $Properties[]
Event Group Markers attached to the command by the workflow author.
Inherited from
failWorkflowExecutionCommandAttributes
• Optional failWorkflowExecutionCommandAttributes: null | $Properties
Command failWorkflowExecutionCommandAttributes
Inherited from
$Properties.failWorkflowExecutionCommandAttributes
modifyWorkflowPropertiesCommandAttributes
• Optional modifyWorkflowPropertiesCommandAttributes: null | $Properties
16 is available for use - it was used as part of a prototype that never made it into a release
Inherited from
$Properties.modifyWorkflowPropertiesCommandAttributes
protocolMessageCommandAttributes
• Optional protocolMessageCommandAttributes: null | $Properties
Command protocolMessageCommandAttributes
Inherited from
$Properties.protocolMessageCommandAttributes
recordMarkerCommandAttributes
• Optional recordMarkerCommandAttributes: null | $Properties
Command recordMarkerCommandAttributes
Inherited from
$Properties.recordMarkerCommandAttributes
requestCancelActivityTaskCommandAttributes
• Optional requestCancelActivityTaskCommandAttributes: null | $Properties
Command requestCancelActivityTaskCommandAttributes
Inherited from
$Properties.requestCancelActivityTaskCommandAttributes
requestCancelExternalWorkflowExecutionCommandAttributes
• Optional requestCancelExternalWorkflowExecutionCommandAttributes: null | $Properties
Command requestCancelExternalWorkflowExecutionCommandAttributes
Inherited from
$Properties.requestCancelExternalWorkflowExecutionCommandAttributes
requestCancelNexusOperationCommandAttributes
• Optional requestCancelNexusOperationCommandAttributes: null | $Properties
Command requestCancelNexusOperationCommandAttributes
Inherited from
$Properties.requestCancelNexusOperationCommandAttributes
scheduleActivityTaskCommandAttributes
• Optional scheduleActivityTaskCommandAttributes: null | $Properties
Command scheduleActivityTaskCommandAttributes
Inherited from
$Properties.scheduleActivityTaskCommandAttributes
scheduleNexusOperationCommandAttributes
• Optional scheduleNexusOperationCommandAttributes: null | $Properties
Command scheduleNexusOperationCommandAttributes
Inherited from
$Properties.scheduleNexusOperationCommandAttributes
signalExternalWorkflowExecutionCommandAttributes
• Optional signalExternalWorkflowExecutionCommandAttributes: null | $Properties
Command signalExternalWorkflowExecutionCommandAttributes
Inherited from
$Properties.signalExternalWorkflowExecutionCommandAttributes
startChildWorkflowExecutionCommandAttributes
• Optional startChildWorkflowExecutionCommandAttributes: null | $Properties
Command startChildWorkflowExecutionCommandAttributes
Inherited from
$Properties.startChildWorkflowExecutionCommandAttributes
startTimerCommandAttributes
• Optional startTimerCommandAttributes: null | $Properties
Command startTimerCommandAttributes
Inherited from
$Properties.startTimerCommandAttributes
upsertWorkflowSearchAttributesCommandAttributes
• Optional upsertWorkflowSearchAttributesCommandAttributes: null | $Properties
Command upsertWorkflowSearchAttributesCommandAttributes
Inherited from
$Properties.upsertWorkflowSearchAttributesCommandAttributes
userMetadata
• Optional userMetadata: null | $Properties
Metadata on the command. This is sometimes carried over to the history event if one is created as a result of the command. Most commands won't have this information, and how this information is used is dependent upon the interface that reads it.
Current well-known uses: start_child_workflow_execution_command_attributes - populates temporal.api.workflow.v1.WorkflowExecutionInfo.user_metadata where the summary and details are used by user interfaces to show fixed as-of-start workflow summary and details. start_timer_command_attributes - populates temporal.api.history.v1.HistoryEvent for timer started where the summary is used to identify the timer.