Skip to main content

Interface: $Properties

Properties of a WorkflowCommand.

Extended by​

Properties​

cancelChildWorkflowExecution?​

optional cancelChildWorkflowExecution?: $Properties | null

WorkflowCommand cancelChildWorkflowExecution

cancelSignalWorkflow?​

optional cancelSignalWorkflow?: $Properties | null

WorkflowCommand cancelSignalWorkflow

cancelTimer?​

optional cancelTimer?: $Properties | null

WorkflowCommand cancelTimer

cancelWorkflowExecution?​

optional cancelWorkflowExecution?: $Properties | null

WorkflowCommand cancelWorkflowExecution

completeWorkflowExecution?​

optional completeWorkflowExecution?: $Properties | null

WorkflowCommand completeWorkflowExecution

continueAsNewWorkflowExecution?​

optional continueAsNewWorkflowExecution?: $Properties | null

WorkflowCommand 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.

failWorkflowExecution?​

optional failWorkflowExecution?: $Properties | null

WorkflowCommand failWorkflowExecution

modifyWorkflowProperties?​

optional modifyWorkflowProperties?: $Properties | null

WorkflowCommand modifyWorkflowProperties

requestCancelActivity?​

optional requestCancelActivity?: $Properties | null

WorkflowCommand requestCancelActivity

requestCancelExternalWorkflowExecution?​

optional requestCancelExternalWorkflowExecution?: $Properties | null

WorkflowCommand requestCancelExternalWorkflowExecution

requestCancelLocalActivity?​

optional requestCancelLocalActivity?: $Properties | null

WorkflowCommand requestCancelLocalActivity

requestCancelNexusOperation?​

optional requestCancelNexusOperation?: $Properties | null

WorkflowCommand requestCancelNexusOperation

respondToQuery?​

optional respondToQuery?: $Properties | null

WorkflowCommand respondToQuery

scheduleActivity?​

optional scheduleActivity?: $Properties | null

WorkflowCommand scheduleActivity

scheduleLocalActivity?​

optional scheduleLocalActivity?: $Properties | null

WorkflowCommand scheduleLocalActivity

scheduleNexusOperation?​

optional scheduleNexusOperation?: $Properties | null

WorkflowCommand scheduleNexusOperation

setPatchMarker?​

optional setPatchMarker?: $Properties | null

WorkflowCommand setPatchMarker

signalExternalWorkflowExecution?​

optional signalExternalWorkflowExecution?: $Properties | null

WorkflowCommand signalExternalWorkflowExecution

startChildWorkflowExecution?​

optional startChildWorkflowExecution?: $Properties | null

WorkflowCommand startChildWorkflowExecution

startTimer?​

optional startTimer?: $Properties | null

WorkflowCommand startTimer

updateResponse?​

optional updateResponse?: $Properties | null

WorkflowCommand updateResponse

upsertWorkflowSearchAttributes?​

optional upsertWorkflowSearchAttributes?: $Properties | null

WorkflowCommand 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.

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