Class: WorkflowCommand

coresdk.workflow_commands.WorkflowCommand

Represents a WorkflowCommand.

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

• eventGroupMarkers: $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.

Methods

toJSON

▸ toJSON(): Object

Converts this WorkflowCommand to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkflowCommand & $Shape

Creates a new WorkflowCommand instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Shape	Properties to set

Returns

WorkflowCommand & $Shape

WorkflowCommand instance

▸ create(properties?): WorkflowCommand

Parameters

Name	Type
properties?	$Properties

Returns

WorkflowCommand

---

decode

▸ decode(reader, length?): WorkflowCommand & $Shape

Decodes a WorkflowCommand message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

WorkflowCommand & $Shape

WorkflowCommand

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkflowCommand & $Shape

Decodes a WorkflowCommand message from the specified reader or buffer, length delimited.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

WorkflowCommand & $Shape

WorkflowCommand

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

Encodes the specified WorkflowCommand message. Does not implicitly coresdk.workflow_commands.WorkflowCommand.verify|verify messages.

Parameters

Name	Type	Description
message	$Properties	WorkflowCommand message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified WorkflowCommand message, length delimited. Does not implicitly coresdk.workflow_commands.WorkflowCommand.verify|verify messages.

Parameters

Name	Type	Description
message	$Properties	WorkflowCommand message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): WorkflowCommand

Creates a WorkflowCommand message from a plain object. Also converts values to their respective internal types.

Parameters

Name	Type	Description
object	Object	Plain object

Returns

WorkflowCommand

WorkflowCommand

---

toObject

▸ toObject(message, options?): Object

Creates a plain object from a WorkflowCommand message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	WorkflowCommand	WorkflowCommand
options?	IConversionOptions	Conversion options

Returns

Object

Plain object