Class: Command

command.v1.Command

Represents a Command.

Properties

attributes

• Optional attributes: "scheduleActivityTaskCommandAttributes" | "startTimerCommandAttributes" | "completeWorkflowExecutionCommandAttributes" | "failWorkflowExecutionCommandAttributes" | "requestCancelActivityTaskCommandAttributes" | "cancelTimerCommandAttributes" | "cancelWorkflowExecutionCommandAttributes" | "requestCancelExternalWorkflowExecutionCommandAttributes" | "recordMarkerCommandAttributes" | "continueAsNewWorkflowExecutionCommandAttributes" | "startChildWorkflowExecutionCommandAttributes" | "signalExternalWorkflowExecutionCommandAttributes" | "upsertWorkflowSearchAttributesCommandAttributes" | "protocolMessageCommandAttributes" | "modifyWorkflowPropertiesCommandAttributes" | "scheduleNexusOperationCommandAttributes" | "requestCancelNexusOperationCommandAttributes"

The command details. The type must match that in command_type.

---

cancelTimerCommandAttributes

• Optional cancelTimerCommandAttributes: null | $Properties

Command cancelTimerCommandAttributes.

---

cancelWorkflowExecutionCommandAttributes

• Optional cancelWorkflowExecutionCommandAttributes: null | $Properties

Command cancelWorkflowExecutionCommandAttributes.

---

commandType

• commandType: CommandType

Command commandType.

---

completeWorkflowExecutionCommandAttributes

• Optional completeWorkflowExecutionCommandAttributes: null | $Properties

Command completeWorkflowExecutionCommandAttributes.

---

continueAsNewWorkflowExecutionCommandAttributes

• Optional continueAsNewWorkflowExecutionCommandAttributes: null | $Properties

Command continueAsNewWorkflowExecutionCommandAttributes.

---

eventGroupMarkers

• eventGroupMarkers: $Properties[]

Event Group Markers attached to the command by the workflow author.

---

failWorkflowExecutionCommandAttributes

• Optional failWorkflowExecutionCommandAttributes: null | $Properties

Command failWorkflowExecutionCommandAttributes.

---

modifyWorkflowPropertiesCommandAttributes

• Optional modifyWorkflowPropertiesCommandAttributes: null | $Properties

16 is available for use - it was used as part of a prototype that never made it into a release

---

protocolMessageCommandAttributes

• Optional protocolMessageCommandAttributes: null | $Properties

Command protocolMessageCommandAttributes.

---

recordMarkerCommandAttributes

• Optional recordMarkerCommandAttributes: null | $Properties

Command recordMarkerCommandAttributes.

---

requestCancelActivityTaskCommandAttributes

• Optional requestCancelActivityTaskCommandAttributes: null | $Properties

Command requestCancelActivityTaskCommandAttributes.

---

requestCancelExternalWorkflowExecutionCommandAttributes

• Optional requestCancelExternalWorkflowExecutionCommandAttributes: null | $Properties

Command requestCancelExternalWorkflowExecutionCommandAttributes.

---

requestCancelNexusOperationCommandAttributes

• Optional requestCancelNexusOperationCommandAttributes: null | $Properties

Command requestCancelNexusOperationCommandAttributes.

---

scheduleActivityTaskCommandAttributes

• Optional scheduleActivityTaskCommandAttributes: null | $Properties

Command scheduleActivityTaskCommandAttributes.

---

scheduleNexusOperationCommandAttributes

• Optional scheduleNexusOperationCommandAttributes: null | $Properties

Command scheduleNexusOperationCommandAttributes.

---

signalExternalWorkflowExecutionCommandAttributes

• Optional signalExternalWorkflowExecutionCommandAttributes: null | $Properties

Command signalExternalWorkflowExecutionCommandAttributes.

---

startChildWorkflowExecutionCommandAttributes

• Optional startChildWorkflowExecutionCommandAttributes: null | $Properties

Command startChildWorkflowExecutionCommandAttributes.

---

startTimerCommandAttributes

• Optional startTimerCommandAttributes: null | $Properties

Command startTimerCommandAttributes.

---

upsertWorkflowSearchAttributesCommandAttributes

• Optional upsertWorkflowSearchAttributesCommandAttributes: null | $Properties

Command upsertWorkflowSearchAttributesCommandAttributes.

---

userMetadata

• Optional userMetadata: null | $Properties

Metadata on the command. This is sometimes carried over to the history event if one is created as a result of the command. Most commands won't have this information, and how this information is used is dependent upon the interface that reads it.

Current well-known uses:

• start_child_workflow_execution_command_attributes - populates temporal.api.workflow.v1.WorkflowExecutionInfo.user_metadata where the summary and details are used by user interfaces to show fixed as-of-start workflow summary and details.
• start_timer_command_attributes - populates temporal.api.history.v1.HistoryEvent for timer started where the summary is used to identify the timer.

Methods

toJSON

▸ toJSON(): Object

Converts this Command to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): Command & $Shape

Creates a new Command instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Shape	Properties to set

Returns

Command & $Shape

Command instance

▸ create(properties?): Command

Parameters

Name	Type
properties?	$Properties

Returns

Command

---

decode

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

Decodes a Command 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

Command & $Shape

Command

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): Command & $Shape

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

Parameters

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

Returns

Command & $Shape

Command

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 Command message. Does not implicitly temporal.api.command.v1.Command.verify|verify messages.

Parameters

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

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified Command message, length delimited. Does not implicitly temporal.api.command.v1.Command.verify|verify messages.

Parameters

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

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): Command

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

Command

Command

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	Command	Command
options?	IConversionOptions	Conversion options

Returns

Object

Plain object