Skip to main content

Class: RequestCancelExternalWorkflowExecution

Request cancellation of an external workflow execution. For cancellation of a child workflow, prefer CancelChildWorkflowExecution instead, as it guards against cancel-before-start issues.

Properties​

reason​

reason: string

A reason for the cancellation

seq​

seq: number

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

workflowExecution?​

optional workflowExecution?: $Properties | null

The workflow instance being targeted

Methods​

toJSON()​

toJSON(): object

Converts this RequestCancelExternalWorkflowExecution to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RequestCancelExternalWorkflowExecution & $Properties

Creates a new RequestCancelExternalWorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RequestCancelExternalWorkflowExecution & $Properties

RequestCancelExternalWorkflowExecution instance

Call Signature​

static create(properties?): RequestCancelExternalWorkflowExecution

Creates a new RequestCancelExternalWorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RequestCancelExternalWorkflowExecution

RequestCancelExternalWorkflowExecution instance

decode()​

static decode(reader, length?): RequestCancelExternalWorkflowExecution & $Properties

Decodes a RequestCancelExternalWorkflowExecution message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

RequestCancelExternalWorkflowExecution & $Properties

RequestCancelExternalWorkflowExecution

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RequestCancelExternalWorkflowExecution & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RequestCancelExternalWorkflowExecution & $Properties

RequestCancelExternalWorkflowExecution

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified RequestCancelExternalWorkflowExecution message. Does not implicitly coresdk.workflow_commands.RequestCancelExternalWorkflowExecution.verify|verify messages.

Parameters​

message​

$Properties

RequestCancelExternalWorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RequestCancelExternalWorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

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​

object​

{[k: string]: any; }

Plain 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​

message​

RequestCancelExternalWorkflowExecution

RequestCancelExternalWorkflowExecution

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object