Skip to main content

Class: WorkflowCommand

coresdk.workflow_commands.WorkflowCommand

Represents a WorkflowCommand.

Implements#

Constructors#

constructor#

new WorkflowCommand(properties?)

Constructs a new WorkflowCommand.

Parameters#

NameType
properties?IWorkflowCommand

Properties#

cancelSignalWorkflow#

Optional cancelSignalWorkflow: null | ICancelSignalWorkflow

WorkflowCommand cancelSignalWorkflow.

Implementation of#

IWorkflowCommand.cancelSignalWorkflow


cancelTimer#

Optional cancelTimer: null | ICancelTimer

WorkflowCommand cancelTimer.

Implementation of#

IWorkflowCommand.cancelTimer


cancelUnstartedChildWorkflowExecution#

Optional cancelUnstartedChildWorkflowExecution: null | ICancelUnstartedChildWorkflowExecution

WorkflowCommand cancelUnstartedChildWorkflowExecution.

Implementation of#

IWorkflowCommand.cancelUnstartedChildWorkflowExecution


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


requestCancelActivity#

Optional requestCancelActivity: null | IRequestCancelActivity

WorkflowCommand requestCancelActivity.

Implementation of#

IWorkflowCommand.requestCancelActivity


requestCancelExternalWorkflowExecution#

Optional requestCancelExternalWorkflowExecution: null | IRequestCancelExternalWorkflowExecution

WorkflowCommand requestCancelExternalWorkflowExecution.

Implementation of#

IWorkflowCommand.requestCancelExternalWorkflowExecution


respondToQuery#

Optional respondToQuery: null | IQueryResult

WorkflowCommand respondToQuery.

Implementation of#

IWorkflowCommand.respondToQuery


scheduleActivity#

Optional scheduleActivity: null | IScheduleActivity

WorkflowCommand scheduleActivity.

Implementation of#

IWorkflowCommand.scheduleActivity


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


variant#

Optional variant: "startTimer" | "scheduleActivity" | "respondToQuery" | "requestCancelActivity" | "cancelTimer" | "completeWorkflowExecution" | "failWorkflowExecution" | "continueAsNewWorkflowExecution" | "cancelWorkflowExecution" | "setPatchMarker" | "startChildWorkflowExecution" | "cancelUnstartedChildWorkflowExecution" | "requestCancelExternalWorkflowExecution" | "signalExternalWorkflowExecution" | "cancelSignalWorkflow"

WorkflowCommand variant.

Methods#

toJSON#

toJSON(): Object

Converts this WorkflowCommand to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): WorkflowCommand

Decodes a WorkflowCommand message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

WorkflowCommand

WorkflowCommand


decodeDelimited#

Static decodeDelimited(reader): WorkflowCommand

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

WorkflowCommand

WorkflowCommand


encode#

Static encode(message, writer?): Writer

Encodes the specified WorkflowCommand message. Does not implicitly {@link coresdk.workflow_commands.WorkflowCommand.verify|verify} messages.

Parameters#

NameTypeDescription
messageIWorkflowCommandWorkflowCommand message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageIWorkflowCommandWorkflowCommand message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): WorkflowCommand

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

WorkflowCommand

WorkflowCommand


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageWorkflowCommandWorkflowCommand
options?IConversionOptions-

Returns#

Object

Plain object