Skip to main content

Class: CancelUnstartedChildWorkflowExecution

coresdk.workflow_commands.CancelUnstartedChildWorkflowExecution

Cancel a not-yet-started child workflow

Implements#

Constructors#

constructor#

new CancelUnstartedChildWorkflowExecution(properties?)

Constructs a new CancelUnstartedChildWorkflowExecution.

Parameters#

NameType
properties?ICancelUnstartedChildWorkflowExecution

Properties#

childWorkflowSeq#

childWorkflowSeq: number

CancelUnstartedChildWorkflowExecution childWorkflowSeq.

Implementation of#

ICancelUnstartedChildWorkflowExecution.childWorkflowSeq

Methods#

toJSON#

toJSON(): Object

Converts this CancelUnstartedChildWorkflowExecution to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): CancelUnstartedChildWorkflowExecution

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

CancelUnstartedChildWorkflowExecution

CancelUnstartedChildWorkflowExecution


decodeDelimited#

Static decodeDelimited(reader): CancelUnstartedChildWorkflowExecution

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

CancelUnstartedChildWorkflowExecution

CancelUnstartedChildWorkflowExecution


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): CancelUnstartedChildWorkflowExecution

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

CancelUnstartedChildWorkflowExecution

CancelUnstartedChildWorkflowExecution


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageCancelUnstartedChildWorkflowExecutionCancelUnstartedChildWorkflowExecution
options?IConversionOptions-

Returns#

Object

Plain object