Skip to main content

Interface: IWorkflowCommand

Properties of a WorkflowCommand.

Extends​

Properties​

cancelChildWorkflowExecution?​

optional cancelChildWorkflowExecution?: $Properties | null

WorkflowCommand cancelChildWorkflowExecution

Inherited from​

$Properties.cancelChildWorkflowExecution

cancelSignalWorkflow?​

optional cancelSignalWorkflow?: $Properties | null

WorkflowCommand cancelSignalWorkflow

Inherited from​

$Properties.cancelSignalWorkflow

cancelTimer?​

optional cancelTimer?: $Properties | null

WorkflowCommand cancelTimer

Inherited from​

$Properties.cancelTimer

cancelWorkflowExecution?​

optional cancelWorkflowExecution?: $Properties | null

WorkflowCommand cancelWorkflowExecution

Inherited from​

$Properties.cancelWorkflowExecution

completeWorkflowExecution?​

optional completeWorkflowExecution?: $Properties | null

WorkflowCommand completeWorkflowExecution

Inherited from​

$Properties.completeWorkflowExecution

continueAsNewWorkflowExecution?​

optional continueAsNewWorkflowExecution?: $Properties | null

WorkflowCommand continueAsNewWorkflowExecution

Inherited from​

$Properties.continueAsNewWorkflowExecution

eventGroupMarkers?​

optional eventGroupMarkers?: $Properties[] | null

Event group markers attached to the command. These are forwarded onto the corresponding server-side Command, and consequently surfaced on the resulting HistoryEvent. See temporal/api/sdk/v1/event_group_marker.proto.

Inherited from​

$Properties.eventGroupMarkers

failWorkflowExecution?​

optional failWorkflowExecution?: $Properties | null

WorkflowCommand failWorkflowExecution

Inherited from​

$Properties.failWorkflowExecution

modifyWorkflowProperties?​

optional modifyWorkflowProperties?: $Properties | null

WorkflowCommand modifyWorkflowProperties

Inherited from​

$Properties.modifyWorkflowProperties

requestCancelActivity?​

optional requestCancelActivity?: $Properties | null

WorkflowCommand requestCancelActivity

Inherited from​

$Properties.requestCancelActivity

requestCancelExternalWorkflowExecution?​

optional requestCancelExternalWorkflowExecution?: $Properties | null

WorkflowCommand requestCancelExternalWorkflowExecution

Inherited from​

$Properties.requestCancelExternalWorkflowExecution

requestCancelLocalActivity?​

optional requestCancelLocalActivity?: $Properties | null

WorkflowCommand requestCancelLocalActivity

Inherited from​

$Properties.requestCancelLocalActivity

requestCancelNexusOperation?​

optional requestCancelNexusOperation?: $Properties | null

WorkflowCommand requestCancelNexusOperation

Inherited from​

$Properties.requestCancelNexusOperation

respondToQuery?​

optional respondToQuery?: $Properties | null

WorkflowCommand respondToQuery

Inherited from​

$Properties.respondToQuery

scheduleActivity?​

optional scheduleActivity?: $Properties | null

WorkflowCommand scheduleActivity

Inherited from​

$Properties.scheduleActivity

scheduleLocalActivity?​

optional scheduleLocalActivity?: $Properties | null

WorkflowCommand scheduleLocalActivity

Inherited from​

$Properties.scheduleLocalActivity

scheduleNexusOperation?​

optional scheduleNexusOperation?: $Properties | null

WorkflowCommand scheduleNexusOperation

Inherited from​

$Properties.scheduleNexusOperation

setPatchMarker?​

optional setPatchMarker?: $Properties | null

WorkflowCommand setPatchMarker

Inherited from​

$Properties.setPatchMarker

signalExternalWorkflowExecution?​

optional signalExternalWorkflowExecution?: $Properties | null

WorkflowCommand signalExternalWorkflowExecution

Inherited from​

$Properties.signalExternalWorkflowExecution

startChildWorkflowExecution?​

optional startChildWorkflowExecution?: $Properties | null

WorkflowCommand startChildWorkflowExecution

Inherited from​

$Properties.startChildWorkflowExecution

startTimer?​

optional startTimer?: $Properties | null

WorkflowCommand startTimer

Inherited from​

$Properties.startTimer

updateResponse?​

optional updateResponse?: $Properties | null

WorkflowCommand updateResponse

Inherited from​

$Properties.updateResponse

upsertWorkflowSearchAttributes?​

optional upsertWorkflowSearchAttributes?: $Properties | null

WorkflowCommand upsertWorkflowSearchAttributes

Inherited from​

$Properties.upsertWorkflowSearchAttributes

userMetadata?​

optional userMetadata?: $Properties | null

User metadata that may or may not be persisted into history depending on the command type. Lang layers are expected to expose the setting of the internals of this metadata on a per-command basis where applicable.

Inherited from​

$Properties.userMetadata

variant?​

optional variant?: "startTimer" | "scheduleActivity" | "respondToQuery" | "requestCancelActivity" | "cancelTimer" | "completeWorkflowExecution" | "failWorkflowExecution" | "continueAsNewWorkflowExecution" | "cancelWorkflowExecution" | "setPatchMarker" | "startChildWorkflowExecution" | "cancelChildWorkflowExecution" | "requestCancelExternalWorkflowExecution" | "signalExternalWorkflowExecution" | "cancelSignalWorkflow" | "scheduleLocalActivity" | "requestCancelLocalActivity" | "upsertWorkflowSearchAttributes" | "modifyWorkflowProperties" | "updateResponse" | "scheduleNexusOperation" | "requestCancelNexusOperation"

WorkflowCommand variant

Inherited from​

$Properties.variant