Skip to main content

Class: CancelWorkflowExecution

coresdk.workflow_commands.CancelWorkflowExecution

containing a cancellation job.

Implements#

Constructors#

constructor#

new CancelWorkflowExecution(properties?)

Constructs a new CancelWorkflowExecution.

Parameters#

NameType
properties?ICancelWorkflowExecution

Methods#

toJSON#

toJSON(): Object

Converts this CancelWorkflowExecution to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): CancelWorkflowExecution

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

CancelWorkflowExecution

CancelWorkflowExecution


decodeDelimited#

Static decodeDelimited(reader): CancelWorkflowExecution

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

CancelWorkflowExecution

CancelWorkflowExecution


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): CancelWorkflowExecution

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

CancelWorkflowExecution

CancelWorkflowExecution


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageCancelWorkflowExecutionCancelWorkflowExecution
options?IConversionOptions-

Returns#

Object

Plain object