Skip to main content

Interface: IWorkflowCommand

coresdk.workflow_commands.IWorkflowCommand

Properties of a WorkflowCommand.

Hierarchy​

Properties​

cancelChildWorkflowExecution​

• Optional cancelChildWorkflowExecution: null | $Properties

WorkflowCommand cancelChildWorkflowExecution

Inherited from​

$Properties.cancelChildWorkflowExecution

cancelSignalWorkflow​

• Optional cancelSignalWorkflow: null | $Properties

WorkflowCommand cancelSignalWorkflow

Inherited from​

$Properties.cancelSignalWorkflow

cancelTimer​

• Optional cancelTimer: null | $Properties

WorkflowCommand cancelTimer

Inherited from​

$Properties.cancelTimer

cancelWorkflowExecution​

• Optional cancelWorkflowExecution: null | $Properties

WorkflowCommand cancelWorkflowExecution

Inherited from​

$Properties.cancelWorkflowExecution

completeWorkflowExecution​

• Optional completeWorkflowExecution: null | $Properties

WorkflowCommand completeWorkflowExecution

Inherited from​

$Properties.completeWorkflowExecution

continueAsNewWorkflowExecution​

• Optional continueAsNewWorkflowExecution: null | $Properties

WorkflowCommand continueAsNewWorkflowExecution

Inherited from​

$Properties.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.

Inherited from​

$Properties.eventGroupMarkers

failWorkflowExecution​

• Optional failWorkflowExecution: null | $Properties

WorkflowCommand failWorkflowExecution

Inherited from​

$Properties.failWorkflowExecution

modifyWorkflowProperties​

• Optional modifyWorkflowProperties: null | $Properties

WorkflowCommand modifyWorkflowProperties

Inherited from​

$Properties.modifyWorkflowProperties

requestCancelActivity​

• Optional requestCancelActivity: null | $Properties

WorkflowCommand requestCancelActivity

Inherited from​

$Properties.requestCancelActivity

requestCancelExternalWorkflowExecution​

• Optional requestCancelExternalWorkflowExecution: null | $Properties

WorkflowCommand requestCancelExternalWorkflowExecution

Inherited from​

$Properties.requestCancelExternalWorkflowExecution

requestCancelLocalActivity​

• Optional requestCancelLocalActivity: null | $Properties

WorkflowCommand requestCancelLocalActivity

Inherited from​

$Properties.requestCancelLocalActivity

requestCancelNexusOperation​

• Optional requestCancelNexusOperation: null | $Properties

WorkflowCommand requestCancelNexusOperation

Inherited from​

$Properties.requestCancelNexusOperation

respondToQuery​

• Optional respondToQuery: null | $Properties

WorkflowCommand respondToQuery

Inherited from​

$Properties.respondToQuery

scheduleActivity​

• Optional scheduleActivity: null | $Properties

WorkflowCommand scheduleActivity

Inherited from​

$Properties.scheduleActivity

scheduleLocalActivity​

• Optional scheduleLocalActivity: null | $Properties

WorkflowCommand scheduleLocalActivity

Inherited from​

$Properties.scheduleLocalActivity

scheduleNexusOperation​

• Optional scheduleNexusOperation: null | $Properties

WorkflowCommand scheduleNexusOperation

Inherited from​

$Properties.scheduleNexusOperation

setPatchMarker​

• Optional setPatchMarker: null | $Properties

WorkflowCommand setPatchMarker

Inherited from​

$Properties.setPatchMarker

signalExternalWorkflowExecution​

• Optional signalExternalWorkflowExecution: null | $Properties

WorkflowCommand signalExternalWorkflowExecution

Inherited from​

$Properties.signalExternalWorkflowExecution

startChildWorkflowExecution​

• Optional startChildWorkflowExecution: null | $Properties

WorkflowCommand startChildWorkflowExecution

Inherited from​

$Properties.startChildWorkflowExecution

startTimer​

• Optional startTimer: null | $Properties

WorkflowCommand startTimer

Inherited from​

$Properties.startTimer

updateResponse​

• Optional updateResponse: null | $Properties

WorkflowCommand updateResponse

Inherited from​

$Properties.updateResponse

upsertWorkflowSearchAttributes​

• Optional upsertWorkflowSearchAttributes: null | $Properties

WorkflowCommand upsertWorkflowSearchAttributes

Inherited from​

$Properties.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.

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