Skip to main content

Interface: ICommand

command.v1.ICommand

Properties of a Command.

Implemented by​

Properties​

cancelTimerCommandAttributes​

• Optional cancelTimerCommandAttributes: null | ICancelTimerCommandAttributes

Command cancelTimerCommandAttributes

cancelWorkflowExecutionCommandAttributes​

• Optional cancelWorkflowExecutionCommandAttributes: null | ICancelWorkflowExecutionCommandAttributes

Command cancelWorkflowExecutionCommandAttributes

commandType​

• Optional commandType: null | CommandType

Command commandType

completeWorkflowExecutionCommandAttributes​

• Optional completeWorkflowExecutionCommandAttributes: null | ICompleteWorkflowExecutionCommandAttributes

Command completeWorkflowExecutionCommandAttributes

continueAsNewWorkflowExecutionCommandAttributes​

• Optional continueAsNewWorkflowExecutionCommandAttributes: null | IContinueAsNewWorkflowExecutionCommandAttributes

Command continueAsNewWorkflowExecutionCommandAttributes

failWorkflowExecutionCommandAttributes​

• Optional failWorkflowExecutionCommandAttributes: null | IFailWorkflowExecutionCommandAttributes

Command failWorkflowExecutionCommandAttributes

modifyWorkflowPropertiesCommandAttributes​

• Optional modifyWorkflowPropertiesCommandAttributes: null | IModifyWorkflowPropertiesCommandAttributes

16 is available for use - it was used as part of a prototype that never made it into a release

protocolMessageCommandAttributes​

• Optional protocolMessageCommandAttributes: null | IProtocolMessageCommandAttributes

Command protocolMessageCommandAttributes

recordMarkerCommandAttributes​

• Optional recordMarkerCommandAttributes: null | IRecordMarkerCommandAttributes

Command recordMarkerCommandAttributes

requestCancelActivityTaskCommandAttributes​

• Optional requestCancelActivityTaskCommandAttributes: null | IRequestCancelActivityTaskCommandAttributes

Command requestCancelActivityTaskCommandAttributes

requestCancelExternalWorkflowExecutionCommandAttributes​

• Optional requestCancelExternalWorkflowExecutionCommandAttributes: null | IRequestCancelExternalWorkflowExecutionCommandAttributes

Command requestCancelExternalWorkflowExecutionCommandAttributes

requestCancelNexusOperationCommandAttributes​

• Optional requestCancelNexusOperationCommandAttributes: null | IRequestCancelNexusOperationCommandAttributes

Command requestCancelNexusOperationCommandAttributes

scheduleActivityTaskCommandAttributes​

• Optional scheduleActivityTaskCommandAttributes: null | IScheduleActivityTaskCommandAttributes

Command scheduleActivityTaskCommandAttributes

scheduleNexusOperationCommandAttributes​

• Optional scheduleNexusOperationCommandAttributes: null | IScheduleNexusOperationCommandAttributes

Command scheduleNexusOperationCommandAttributes

signalExternalWorkflowExecutionCommandAttributes​

• Optional signalExternalWorkflowExecutionCommandAttributes: null | ISignalExternalWorkflowExecutionCommandAttributes

Command signalExternalWorkflowExecutionCommandAttributes

startChildWorkflowExecutionCommandAttributes​

• Optional startChildWorkflowExecutionCommandAttributes: null | IStartChildWorkflowExecutionCommandAttributes

Command startChildWorkflowExecutionCommandAttributes

startTimerCommandAttributes​

• Optional startTimerCommandAttributes: null | IStartTimerCommandAttributes

Command startTimerCommandAttributes

upsertWorkflowSearchAttributesCommandAttributes​

• Optional upsertWorkflowSearchAttributesCommandAttributes: null | IUpsertWorkflowSearchAttributesCommandAttributes

Command upsertWorkflowSearchAttributesCommandAttributes

userMetadata​

• Optional userMetadata: null | IUserMetadata

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.