Class: WorkflowCommand

coresdk.workflow_commands.WorkflowCommand

Represents a WorkflowCommand.

Implements

• IWorkflowCommand

Constructors

constructor

• new WorkflowCommand(properties?): WorkflowCommand

Constructs a new WorkflowCommand.

Parameters

Name	Type	Description
properties?	IWorkflowCommand	Properties to set

Returns

WorkflowCommand

Properties

cancelChildWorkflowExecution

• Optional cancelChildWorkflowExecution: null | ICancelChildWorkflowExecution

WorkflowCommand cancelChildWorkflowExecution.

Implementation of

IWorkflowCommand.cancelChildWorkflowExecution

---

cancelSignalWorkflow

• Optional cancelSignalWorkflow: null | ICancelSignalWorkflow

WorkflowCommand cancelSignalWorkflow.

Implementation of

IWorkflowCommand.cancelSignalWorkflow

---

cancelTimer

• Optional cancelTimer: null | ICancelTimer

WorkflowCommand cancelTimer.

Implementation of

IWorkflowCommand.cancelTimer

---

cancelWorkflowExecution

• Optional cancelWorkflowExecution: null | ICancelWorkflowExecution

WorkflowCommand cancelWorkflowExecution.

Implementation of

IWorkflowCommand.cancelWorkflowExecution

---

completeWorkflowExecution

• Optional completeWorkflowExecution: null | ICompleteWorkflowExecution

WorkflowCommand completeWorkflowExecution.

Implementation of

IWorkflowCommand.completeWorkflowExecution

---

continueAsNewWorkflowExecution

• Optional continueAsNewWorkflowExecution: null | IContinueAsNewWorkflowExecution

WorkflowCommand continueAsNewWorkflowExecution.

Implementation of

IWorkflowCommand.continueAsNewWorkflowExecution

---

failWorkflowExecution

• Optional failWorkflowExecution: null | IFailWorkflowExecution

WorkflowCommand failWorkflowExecution.

Implementation of

IWorkflowCommand.failWorkflowExecution

---

modifyWorkflowProperties

• Optional modifyWorkflowProperties: null | IModifyWorkflowProperties

WorkflowCommand modifyWorkflowProperties.

Implementation of

IWorkflowCommand.modifyWorkflowProperties

---

requestCancelActivity

• Optional requestCancelActivity: null | IRequestCancelActivity

WorkflowCommand requestCancelActivity.

Implementation of

IWorkflowCommand.requestCancelActivity

---

requestCancelExternalWorkflowExecution

• Optional requestCancelExternalWorkflowExecution: null | IRequestCancelExternalWorkflowExecution

WorkflowCommand requestCancelExternalWorkflowExecution.

Implementation of

IWorkflowCommand.requestCancelExternalWorkflowExecution

---

requestCancelLocalActivity

• Optional requestCancelLocalActivity: null | IRequestCancelLocalActivity

WorkflowCommand requestCancelLocalActivity.

Implementation of

IWorkflowCommand.requestCancelLocalActivity

---

respondToQuery

• Optional respondToQuery: null | IQueryResult

WorkflowCommand respondToQuery.

Implementation of

IWorkflowCommand.respondToQuery

---

scheduleActivity

• Optional scheduleActivity: null | IScheduleActivity

WorkflowCommand scheduleActivity.

Implementation of

IWorkflowCommand.scheduleActivity

---

scheduleLocalActivity

• Optional scheduleLocalActivity: null | IScheduleLocalActivity

WorkflowCommand scheduleLocalActivity.

Implementation of

IWorkflowCommand.scheduleLocalActivity

---

setPatchMarker

• Optional setPatchMarker: null | ISetPatchMarker

WorkflowCommand setPatchMarker.

Implementation of

IWorkflowCommand.setPatchMarker

---

signalExternalWorkflowExecution

• Optional signalExternalWorkflowExecution: null | ISignalExternalWorkflowExecution

WorkflowCommand signalExternalWorkflowExecution.

Implementation of

IWorkflowCommand.signalExternalWorkflowExecution

---

startChildWorkflowExecution

• Optional startChildWorkflowExecution: null | IStartChildWorkflowExecution

WorkflowCommand startChildWorkflowExecution.

Implementation of

IWorkflowCommand.startChildWorkflowExecution

---

startTimer

• Optional startTimer: null | IStartTimer

WorkflowCommand startTimer.

Implementation of

IWorkflowCommand.startTimer

---

updateResponse

• Optional updateResponse: null | IUpdateResponse

WorkflowCommand updateResponse.

Implementation of

IWorkflowCommand.updateResponse

---

upsertWorkflowSearchAttributes

• Optional upsertWorkflowSearchAttributes: null | IUpsertWorkflowSearchAttributes

WorkflowCommand upsertWorkflowSearchAttributes.

Implementation of

IWorkflowCommand.upsertWorkflowSearchAttributes

---

userMetadata

• Optional userMetadata: null | IUserMetadata

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.

Implementation of

IWorkflowCommand.userMetadata

---

variant

• Optional variant: "startTimer" | "scheduleActivity" | "respondToQuery" | "requestCancelActivity" | "cancelTimer" | "completeWorkflowExecution" | "failWorkflowExecution" | "continueAsNewWorkflowExecution" | "cancelWorkflowExecution" | "setPatchMarker" | "startChildWorkflowExecution" | "cancelChildWorkflowExecution" | "requestCancelExternalWorkflowExecution" | "signalExternalWorkflowExecution" | "cancelSignalWorkflow" | "scheduleLocalActivity" | "requestCancelLocalActivity" | "upsertWorkflowSearchAttributes" | "modifyWorkflowProperties" | "updateResponse"

WorkflowCommand variant.

Methods

toJSON

▸ toJSON(): Object

Converts this WorkflowCommand to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkflowCommand

Creates a new WorkflowCommand instance using the specified properties.

Parameters

Name	Type	Description
properties?	IWorkflowCommand	Properties to set

Returns

WorkflowCommand

WorkflowCommand instance

---

decode

▸ decode(reader, length?): WorkflowCommand

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

WorkflowCommand

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkflowCommand

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

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	IWorkflowCommand	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	IWorkflowCommand	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

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowCommand

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

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