Skip to main content

Class: CanceledFailureInfo

Represents a CanceledFailureInfo.

Properties​

details?​

optional details?: $Properties | null

CanceledFailureInfo details.

identity​

identity: string

The identity of the worker or client that requested the cancellation.

Methods​

toJSON()​

toJSON(): object

Converts this CanceledFailureInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CanceledFailureInfo & $Properties

Creates a new CanceledFailureInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CanceledFailureInfo & $Properties

CanceledFailureInfo instance

Call Signature​

static create(properties?): CanceledFailureInfo

Creates a new CanceledFailureInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CanceledFailureInfo

CanceledFailureInfo instance

decode()​

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

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

CanceledFailureInfo & $Properties

CanceledFailureInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CanceledFailureInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CanceledFailureInfo & $Properties

CanceledFailureInfo

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 CanceledFailureInfo message. Does not implicitly temporal.api.failure.v1.CanceledFailureInfo.verify|verify messages.

Parameters​

message​

$Properties

CanceledFailureInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified CanceledFailureInfo message, length delimited. Does not implicitly temporal.api.failure.v1.CanceledFailureInfo.verify|verify messages.

Parameters​

message​

$Properties

CanceledFailureInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CanceledFailureInfo

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

Parameters​

object​

Plain object

Returns​

CanceledFailureInfo

CanceledFailureInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CanceledFailureInfo

CanceledFailureInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object