Skip to main content

Class: UnsuccessfulOperationError

Represents an UnsuccessfulOperationError.

Properties​

failure?​

optional failure?: $Properties | null

UnsuccessfulOperationError failure.

operationState​

operationState: string

See https://github.com/nexus-rpc/api/blob/main/SPEC.md#operationinfo.

Methods​

toJSON()​

toJSON(): object

Converts this UnsuccessfulOperationError to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UnsuccessfulOperationError & $Properties

Creates a new UnsuccessfulOperationError instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UnsuccessfulOperationError & $Properties

UnsuccessfulOperationError instance

Call Signature​

static create(properties?): UnsuccessfulOperationError

Creates a new UnsuccessfulOperationError instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UnsuccessfulOperationError

UnsuccessfulOperationError instance

decode()​

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

Decodes an UnsuccessfulOperationError 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​

UnsuccessfulOperationError & $Properties

UnsuccessfulOperationError

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UnsuccessfulOperationError & $Properties

Decodes an UnsuccessfulOperationError message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UnsuccessfulOperationError & $Properties

UnsuccessfulOperationError

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

Parameters​

message​

$Properties

UnsuccessfulOperationError message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UnsuccessfulOperationError message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UnsuccessfulOperationError

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

Parameters​

object​

Plain object

Returns​

UnsuccessfulOperationError

UnsuccessfulOperationError

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UnsuccessfulOperationError

UnsuccessfulOperationError

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object