Skip to main content

Class: RequestCancelExternalWorkflowExecution

coresdk.workflow_commands.RequestCancelExternalWorkflowExecution

Request cancellation of an external workflow execution (which may be a started child)

Implements#

Constructors#

constructor#

new RequestCancelExternalWorkflowExecution(properties?)

Constructs a new RequestCancelExternalWorkflowExecution.

Parameters#

NameType
properties?IRequestCancelExternalWorkflowExecution

Properties#

childWorkflowId#

Optional childWorkflowId: null | string

RequestCancelExternalWorkflowExecution childWorkflowId.

Implementation of#

IRequestCancelExternalWorkflowExecution.childWorkflowId


seq#

seq: number

Lang's incremental sequence number, used as the operation identifier

Implementation of#

IRequestCancelExternalWorkflowExecution.seq


target#

Optional target: "workflowExecution" | "childWorkflowId"

RequestCancelExternalWorkflowExecution target.


workflowExecution#

Optional workflowExecution: null | INamespacedWorkflowExecution

RequestCancelExternalWorkflowExecution workflowExecution.

Implementation of#

IRequestCancelExternalWorkflowExecution.workflowExecution

Methods#

toJSON#

toJSON(): Object

Converts this RequestCancelExternalWorkflowExecution to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): RequestCancelExternalWorkflowExecution

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

RequestCancelExternalWorkflowExecution

RequestCancelExternalWorkflowExecution


decodeDelimited#

Static decodeDelimited(reader): RequestCancelExternalWorkflowExecution

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

RequestCancelExternalWorkflowExecution

RequestCancelExternalWorkflowExecution


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): RequestCancelExternalWorkflowExecution

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

RequestCancelExternalWorkflowExecution

RequestCancelExternalWorkflowExecution


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageRequestCancelExternalWorkflowExecutionRequestCancelExternalWorkflowExecution
options?IConversionOptions-

Returns#

Object

Plain object