Skip to main content

Class: NexusOperationFailureInfo

Representation of the Temporal SDK NexusOperationError object that is returned to workflow callers.

Properties​

endpoint​

endpoint: string

Endpoint name.

operation​

operation: string

Operation name.

operationId​

operationId: string

Operation ID - may be empty if the operation completed synchronously.

Deprecated. Renamed to operation_token.

operationToken​

operationToken: string

Operation token - may be empty if the operation completed synchronously.

scheduledEventId​

scheduledEventId: Long

The NexusOperationScheduled event ID.

service​

service: string

Service name.

Methods​

toJSON()​

toJSON(): object

Converts this NexusOperationFailureInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NexusOperationFailureInfo & $Properties

Creates a new NexusOperationFailureInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NexusOperationFailureInfo & $Properties

NexusOperationFailureInfo instance

Call Signature​

static create(properties?): NexusOperationFailureInfo

Creates a new NexusOperationFailureInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NexusOperationFailureInfo

NexusOperationFailureInfo instance

decode()​

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

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

NexusOperationFailureInfo & $Properties

NexusOperationFailureInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NexusOperationFailureInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NexusOperationFailureInfo & $Properties

NexusOperationFailureInfo

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

Parameters​

message​

$Properties

NexusOperationFailureInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NexusOperationFailureInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NexusOperationFailureInfo

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

Parameters​

object​

Plain object

Returns​

NexusOperationFailureInfo

NexusOperationFailureInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NexusOperationFailureInfo

NexusOperationFailureInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object