Skip to main content

Class: Cancellation

Used in ChildWorkflowResult to report cancellation. Failure should be ChildWorkflowFailure with a CanceledFailure cause.

Properties​

failure?​

optional failure?: $Properties | null

Cancellation failure.

Methods​

toJSON()​

toJSON(): object

Converts this Cancellation to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Cancellation & $Shape

Creates a new Cancellation instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Cancellation & $Shape

Cancellation instance

Call Signature​

static create(properties?): Cancellation

Creates a new Cancellation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Cancellation

Cancellation instance

decode()​

static decode(reader, length?): Cancellation & $Shape

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

Cancellation & $Shape

Cancellation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Cancellation & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Cancellation & $Shape

Cancellation

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

Parameters​

message​

$Properties

Cancellation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Cancellation message, length delimited. Does not implicitly coresdk.child_workflow.Cancellation.verify|verify messages.

Parameters​

message​

$Properties

Cancellation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Cancellation

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Cancellation

Cancellation

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Cancellation

Cancellation

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object