Skip to main content

Interface: $Properties

Properties of a Command.

Extended by​

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.

cancelTimerCommandAttributes?​

optional cancelTimerCommandAttributes?: $Properties | null

Command cancelTimerCommandAttributes

cancelWorkflowExecutionCommandAttributes?​

optional cancelWorkflowExecutionCommandAttributes?: $Properties | null

Command cancelWorkflowExecutionCommandAttributes

commandType?​

optional commandType?: CommandType | null

Command commandType

completeWorkflowExecutionCommandAttributes?​

optional completeWorkflowExecutionCommandAttributes?: $Properties | null

Command completeWorkflowExecutionCommandAttributes

continueAsNewWorkflowExecutionCommandAttributes?​

optional continueAsNewWorkflowExecutionCommandAttributes?: $Properties | null

Command continueAsNewWorkflowExecutionCommandAttributes

eventGroupMarkers?​

optional eventGroupMarkers?: $Properties[] | null

Event Group Markers attached to the command by the workflow author.

failWorkflowExecutionCommandAttributes?​

optional failWorkflowExecutionCommandAttributes?: $Properties | null

Command failWorkflowExecutionCommandAttributes

modifyWorkflowPropertiesCommandAttributes?​

optional modifyWorkflowPropertiesCommandAttributes?: $Properties | null

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

protocolMessageCommandAttributes?​

optional protocolMessageCommandAttributes?: $Properties | null

Command protocolMessageCommandAttributes

recordMarkerCommandAttributes?​

optional recordMarkerCommandAttributes?: $Properties | null

Command recordMarkerCommandAttributes

requestCancelActivityTaskCommandAttributes?​

optional requestCancelActivityTaskCommandAttributes?: $Properties | null

Command requestCancelActivityTaskCommandAttributes

requestCancelExternalWorkflowExecutionCommandAttributes?​

optional requestCancelExternalWorkflowExecutionCommandAttributes?: $Properties | null

Command requestCancelExternalWorkflowExecutionCommandAttributes

requestCancelNexusOperationCommandAttributes?​

optional requestCancelNexusOperationCommandAttributes?: $Properties | null

Command requestCancelNexusOperationCommandAttributes

scheduleActivityTaskCommandAttributes?​

optional scheduleActivityTaskCommandAttributes?: $Properties | null

Command scheduleActivityTaskCommandAttributes

scheduleNexusOperationCommandAttributes?​

optional scheduleNexusOperationCommandAttributes?: $Properties | null

Command scheduleNexusOperationCommandAttributes

signalExternalWorkflowExecutionCommandAttributes?​

optional signalExternalWorkflowExecutionCommandAttributes?: $Properties | null

Command signalExternalWorkflowExecutionCommandAttributes

startChildWorkflowExecutionCommandAttributes?​

optional startChildWorkflowExecutionCommandAttributes?: $Properties | null

Command startChildWorkflowExecutionCommandAttributes

startTimerCommandAttributes?​

optional startTimerCommandAttributes?: $Properties | null

Command startTimerCommandAttributes

upsertWorkflowSearchAttributesCommandAttributes?​

optional upsertWorkflowSearchAttributesCommandAttributes?: $Properties | null

Command upsertWorkflowSearchAttributesCommandAttributes

userMetadata?​

optional userMetadata?: $Properties | null

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.