Skip to main content

Class: Command

command.v1.Command

Represents a Command.

Implements#

Constructors#

constructor#

new Command(properties?)

Constructs a new Command.

Parameters#

NameType
properties?ICommand

Properties#

attributes#

Optional attributes: "scheduleActivityTaskCommandAttributes" | "startTimerCommandAttributes" | "completeWorkflowExecutionCommandAttributes" | "failWorkflowExecutionCommandAttributes" | "requestCancelActivityTaskCommandAttributes" | "cancelTimerCommandAttributes" | "cancelWorkflowExecutionCommandAttributes" | "requestCancelExternalWorkflowExecutionCommandAttributes" | "recordMarkerCommandAttributes" | "continueAsNewWorkflowExecutionCommandAttributes" | "startChildWorkflowExecutionCommandAttributes" | "signalExternalWorkflowExecutionCommandAttributes" | "upsertWorkflowSearchAttributesCommandAttributes"

Command attributes.


cancelTimerCommandAttributes#

Optional cancelTimerCommandAttributes: null | ICancelTimerCommandAttributes

Command cancelTimerCommandAttributes.

Implementation of#

ICommand.cancelTimerCommandAttributes


cancelWorkflowExecutionCommandAttributes#

Optional cancelWorkflowExecutionCommandAttributes: null | ICancelWorkflowExecutionCommandAttributes

Command cancelWorkflowExecutionCommandAttributes.

Implementation of#

ICommand.cancelWorkflowExecutionCommandAttributes


commandType#

commandType: CommandType

Command commandType.

Implementation of#

ICommand.commandType


completeWorkflowExecutionCommandAttributes#

Optional completeWorkflowExecutionCommandAttributes: null | ICompleteWorkflowExecutionCommandAttributes

Command completeWorkflowExecutionCommandAttributes.

Implementation of#

ICommand.completeWorkflowExecutionCommandAttributes


continueAsNewWorkflowExecutionCommandAttributes#

Optional continueAsNewWorkflowExecutionCommandAttributes: null | IContinueAsNewWorkflowExecutionCommandAttributes

Command continueAsNewWorkflowExecutionCommandAttributes.

Implementation of#

ICommand.continueAsNewWorkflowExecutionCommandAttributes


failWorkflowExecutionCommandAttributes#

Optional failWorkflowExecutionCommandAttributes: null | IFailWorkflowExecutionCommandAttributes

Command failWorkflowExecutionCommandAttributes.

Implementation of#

ICommand.failWorkflowExecutionCommandAttributes


recordMarkerCommandAttributes#

Optional recordMarkerCommandAttributes: null | IRecordMarkerCommandAttributes

Command recordMarkerCommandAttributes.

Implementation of#

ICommand.recordMarkerCommandAttributes


requestCancelActivityTaskCommandAttributes#

Optional requestCancelActivityTaskCommandAttributes: null | IRequestCancelActivityTaskCommandAttributes

Command requestCancelActivityTaskCommandAttributes.

Implementation of#

ICommand.requestCancelActivityTaskCommandAttributes


requestCancelExternalWorkflowExecutionCommandAttributes#

Optional requestCancelExternalWorkflowExecutionCommandAttributes: null | IRequestCancelExternalWorkflowExecutionCommandAttributes

Command requestCancelExternalWorkflowExecutionCommandAttributes.

Implementation of#

ICommand.requestCancelExternalWorkflowExecutionCommandAttributes


scheduleActivityTaskCommandAttributes#

Optional scheduleActivityTaskCommandAttributes: null | IScheduleActivityTaskCommandAttributes

Command scheduleActivityTaskCommandAttributes.

Implementation of#

ICommand.scheduleActivityTaskCommandAttributes


signalExternalWorkflowExecutionCommandAttributes#

Optional signalExternalWorkflowExecutionCommandAttributes: null | ISignalExternalWorkflowExecutionCommandAttributes

Command signalExternalWorkflowExecutionCommandAttributes.

Implementation of#

ICommand.signalExternalWorkflowExecutionCommandAttributes


startChildWorkflowExecutionCommandAttributes#

Optional startChildWorkflowExecutionCommandAttributes: null | IStartChildWorkflowExecutionCommandAttributes

Command startChildWorkflowExecutionCommandAttributes.

Implementation of#

ICommand.startChildWorkflowExecutionCommandAttributes


startTimerCommandAttributes#

Optional startTimerCommandAttributes: null | IStartTimerCommandAttributes

Command startTimerCommandAttributes.

Implementation of#

ICommand.startTimerCommandAttributes


upsertWorkflowSearchAttributesCommandAttributes#

Optional upsertWorkflowSearchAttributesCommandAttributes: null | IUpsertWorkflowSearchAttributesCommandAttributes

Command upsertWorkflowSearchAttributesCommandAttributes.

Implementation of#

ICommand.upsertWorkflowSearchAttributesCommandAttributes

Methods#

toJSON#

toJSON(): Object

Converts this Command to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): Command

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

Command

Command


decodeDelimited#

Static decodeDelimited(reader): Command

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

Command

Command


encode#

Static encode(message, writer?): Writer

Encodes the specified Command message. Does not implicitly {@link temporal.api.command.v1.Command.verify|verify} messages.

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): Command

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

Command

Command


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageCommandCommand
options?IConversionOptions-

Returns#

Object

Plain object