Skip to main content

WorkflowCommand

Interfaces​

Type Aliases​

$Shape​

$Shape = object & { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: undefined; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer: $Shape; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "startTimer"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity: $Shape; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "scheduleActivity"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery: $Shape; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "respondToQuery"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity: $Shape; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "requestCancelActivity"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer: $Shape; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "cancelTimer"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution: $Shape; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "completeWorkflowExecution"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution: $Shape; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "failWorkflowExecution"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution: $Shape; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "continueAsNewWorkflowExecution"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution: $Shape; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "cancelWorkflowExecution"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker: $Shape; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "setPatchMarker"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution: $Shape; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "startChildWorkflowExecution"; } | { cancelChildWorkflowExecution: $Shape; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "cancelChildWorkflowExecution"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution: $Shape; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "requestCancelExternalWorkflowExecution"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution: $Shape; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "signalExternalWorkflowExecution"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow: $Shape; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "cancelSignalWorkflow"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity: $Shape; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "scheduleLocalActivity"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity: $Shape; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "requestCancelLocalActivity"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes: $Shape; variant?: "upsertWorkflowSearchAttributes"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties: $Shape; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "modifyWorkflowProperties"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse: $Shape; upsertWorkflowSearchAttributes?: null; variant?: "updateResponse"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation?: null; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation: $Shape; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "scheduleNexusOperation"; } | { cancelChildWorkflowExecution?: null; cancelSignalWorkflow?: null; cancelTimer?: null; cancelWorkflowExecution?: null; completeWorkflowExecution?: null; continueAsNewWorkflowExecution?: null; failWorkflowExecution?: null; modifyWorkflowProperties?: null; requestCancelActivity?: null; requestCancelExternalWorkflowExecution?: null; requestCancelLocalActivity?: null; requestCancelNexusOperation: $Shape; respondToQuery?: null; scheduleActivity?: null; scheduleLocalActivity?: null; scheduleNexusOperation?: null; setPatchMarker?: null; signalExternalWorkflowExecution?: null; startChildWorkflowExecution?: null; startTimer?: null; updateResponse?: null; upsertWorkflowSearchAttributes?: null; variant?: "requestCancelNexusOperation"; }

Narrowed shape of a WorkflowCommand.

Type Declaration​

cancelChildWorkflowExecution?​

optional cancelChildWorkflowExecution?: $Shape | null

cancelSignalWorkflow?​

optional cancelSignalWorkflow?: $Shape | null

cancelTimer?​

optional cancelTimer?: $Shape | null

cancelWorkflowExecution?​

optional cancelWorkflowExecution?: $Shape | null

completeWorkflowExecution?​

optional completeWorkflowExecution?: $Shape | null

continueAsNewWorkflowExecution?​

optional continueAsNewWorkflowExecution?: $Shape | null

eventGroupMarkers?​

optional eventGroupMarkers?: $Shape[] | null

failWorkflowExecution?​

optional failWorkflowExecution?: $Shape | null

modifyWorkflowProperties?​

optional modifyWorkflowProperties?: $Shape | null

requestCancelActivity?​

optional requestCancelActivity?: $Shape | null

requestCancelExternalWorkflowExecution?​

optional requestCancelExternalWorkflowExecution?: $Shape | null

requestCancelLocalActivity?​

optional requestCancelLocalActivity?: $Shape | null

requestCancelNexusOperation?​

optional requestCancelNexusOperation?: $Shape | null

respondToQuery?​

optional respondToQuery?: $Shape | null

scheduleActivity?​

optional scheduleActivity?: $Shape | null

scheduleLocalActivity?​

optional scheduleLocalActivity?: $Shape | null

scheduleNexusOperation?​

optional scheduleNexusOperation?: $Shape | null

setPatchMarker?​

optional setPatchMarker?: $Shape | null

signalExternalWorkflowExecution?​

optional signalExternalWorkflowExecution?: $Shape | null

startChildWorkflowExecution?​

optional startChildWorkflowExecution?: $Shape | null

startTimer?​

optional startTimer?: $Shape | null

updateResponse?​

optional updateResponse?: $Shape | null

upsertWorkflowSearchAttributes?​

optional upsertWorkflowSearchAttributes?: $Shape | null

userMetadata?​

optional userMetadata?: $Shape | null