Skip to main content

Class: CancelWorkflowExecution

Indicate a workflow has completed as cancelled. Generally sent as a response to an activation containing a cancellation job.

Properties​

details?​

optional details?: $Properties | null

CancelWorkflowExecution details.

Methods​

toJSON()​

toJSON(): object

Converts this CancelWorkflowExecution to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CancelWorkflowExecution & $Properties

Creates a new CancelWorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelWorkflowExecution & $Properties

CancelWorkflowExecution instance

Call Signature​

static create(properties?): CancelWorkflowExecution

Creates a new CancelWorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelWorkflowExecution

CancelWorkflowExecution instance

decode()​

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

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

CancelWorkflowExecution & $Properties

CancelWorkflowExecution

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CancelWorkflowExecution & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CancelWorkflowExecution & $Properties

CancelWorkflowExecution

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 CancelWorkflowExecution message. Does not implicitly coresdk.workflow_commands.CancelWorkflowExecution.verify|verify messages.

Parameters​

message​

$Properties

CancelWorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CancelWorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

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​

object​

{[k: string]: any; }

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

message​

CancelWorkflowExecution

CancelWorkflowExecution

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object