Skip to main content

Interface: $Properties

workflow_commands.WorkflowCommand.$Properties

Properties of a WorkflowCommand.

Hierarchy​

Properties​

cancelChildWorkflowExecution​

• Optional cancelChildWorkflowExecution: null | $Properties

WorkflowCommand cancelChildWorkflowExecution

cancelSignalWorkflow​

• Optional cancelSignalWorkflow: null | $Properties

WorkflowCommand cancelSignalWorkflow

cancelTimer​

• Optional cancelTimer: null | $Properties

WorkflowCommand cancelTimer

cancelWorkflowExecution​

• Optional cancelWorkflowExecution: null | $Properties

WorkflowCommand cancelWorkflowExecution

completeWorkflowExecution​

• Optional completeWorkflowExecution: null | $Properties

WorkflowCommand completeWorkflowExecution

continueAsNewWorkflowExecution​

• Optional continueAsNewWorkflowExecution: null | $Properties

WorkflowCommand continueAsNewWorkflowExecution

eventGroupMarkers​

• Optional eventGroupMarkers: null | $Properties[]

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: null | $Properties

WorkflowCommand failWorkflowExecution

modifyWorkflowProperties​

• Optional modifyWorkflowProperties: null | $Properties

WorkflowCommand modifyWorkflowProperties

requestCancelActivity​

• Optional requestCancelActivity: null | $Properties

WorkflowCommand requestCancelActivity

requestCancelExternalWorkflowExecution​

• Optional requestCancelExternalWorkflowExecution: null | $Properties

WorkflowCommand requestCancelExternalWorkflowExecution

requestCancelLocalActivity​

• Optional requestCancelLocalActivity: null | $Properties

WorkflowCommand requestCancelLocalActivity

requestCancelNexusOperation​

• Optional requestCancelNexusOperation: null | $Properties

WorkflowCommand requestCancelNexusOperation

respondToQuery​

• Optional respondToQuery: null | $Properties

WorkflowCommand respondToQuery

scheduleActivity​

• Optional scheduleActivity: null | $Properties

WorkflowCommand scheduleActivity

scheduleLocalActivity​

• Optional scheduleLocalActivity: null | $Properties

WorkflowCommand scheduleLocalActivity

scheduleNexusOperation​

• Optional scheduleNexusOperation: null | $Properties

WorkflowCommand scheduleNexusOperation

setPatchMarker​

• Optional setPatchMarker: null | $Properties

WorkflowCommand setPatchMarker

signalExternalWorkflowExecution​

• Optional signalExternalWorkflowExecution: null | $Properties

WorkflowCommand signalExternalWorkflowExecution

startChildWorkflowExecution​

• Optional startChildWorkflowExecution: null | $Properties

WorkflowCommand startChildWorkflowExecution

startTimer​

• Optional startTimer: null | $Properties

WorkflowCommand startTimer

updateResponse​

• Optional updateResponse: null | $Properties

WorkflowCommand updateResponse

upsertWorkflowSearchAttributes​

• Optional upsertWorkflowSearchAttributes: null | $Properties

WorkflowCommand upsertWorkflowSearchAttributes

userMetadata​

• Optional userMetadata: null | $Properties

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