Skip to main content

Class: NexusOperationCanceledEventAttributes

Nexus operation completed as canceled. May or may not have been due to a cancellation request by the workflow.

Properties​

failure?​

optional failure?: $Properties | null

Cancellation details.

requestId​

requestId: string

The request ID allocated at schedule time.

scheduledEventId​

scheduledEventId: Long

The ID of the NEXUS_OPERATION_SCHEDULED event. Uniquely identifies this operation.

Methods​

toJSON()​

toJSON(): object

Converts this NexusOperationCanceledEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NexusOperationCanceledEventAttributes & $Shape

Creates a new NexusOperationCanceledEventAttributes instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

NexusOperationCanceledEventAttributes & $Shape

NexusOperationCanceledEventAttributes instance

Call Signature​

static create(properties?): NexusOperationCanceledEventAttributes

Creates a new NexusOperationCanceledEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NexusOperationCanceledEventAttributes

NexusOperationCanceledEventAttributes instance

decode()​

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

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

NexusOperationCanceledEventAttributes & $Shape

NexusOperationCanceledEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NexusOperationCanceledEventAttributes & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NexusOperationCanceledEventAttributes & $Shape

NexusOperationCanceledEventAttributes

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

Parameters​

message​

$Properties

NexusOperationCanceledEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NexusOperationCanceledEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NexusOperationCanceledEventAttributes

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

Parameters​

object​

Plain object

Returns​

NexusOperationCanceledEventAttributes

NexusOperationCanceledEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NexusOperationCanceledEventAttributes

NexusOperationCanceledEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object