Skip to main content

Class: NexusOperationExecutionCancellationInfo

NexusOperationExecutionCancellationInfo contains the state of a Nexus operation cancellation.

Properties​

attempt​

attempt: number

The number of attempts made to deliver the cancel operation request. This number represents a minimum bound since the attempt is incremented after the request completes.

blockedReason​

blockedReason: string

If the state is BLOCKED, blocked reason provides additional information.

lastAttemptCompleteTime?​

optional lastAttemptCompleteTime?: $Properties | null

The time when the last attempt completed.

lastAttemptFailure?​

optional lastAttemptFailure?: $Properties | null

The last attempt's failure, if any.

nextAttemptScheduleTime?​

optional nextAttemptScheduleTime?: $Properties | null

The time when the next attempt is scheduled.

reason​

reason: string

A reason that may be specified in the CancelNexusOperationRequest.

requestedTime?​

optional requestedTime?: $Properties | null

The time when cancellation was requested.

state​

state: NexusOperationCancellationState

NexusOperationExecutionCancellationInfo state.

Methods​

toJSON()​

toJSON(): object

Converts this NexusOperationExecutionCancellationInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NexusOperationExecutionCancellationInfo & $Shape

Creates a new NexusOperationExecutionCancellationInfo instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

NexusOperationExecutionCancellationInfo & $Shape

NexusOperationExecutionCancellationInfo instance

Call Signature​

static create(properties?): NexusOperationExecutionCancellationInfo

Creates a new NexusOperationExecutionCancellationInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NexusOperationExecutionCancellationInfo

NexusOperationExecutionCancellationInfo instance

decode()​

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

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

NexusOperationExecutionCancellationInfo & $Shape

NexusOperationExecutionCancellationInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NexusOperationExecutionCancellationInfo & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NexusOperationExecutionCancellationInfo & $Shape

NexusOperationExecutionCancellationInfo

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

Parameters​

message​

$Properties

NexusOperationExecutionCancellationInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NexusOperationExecutionCancellationInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NexusOperationExecutionCancellationInfo

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

NexusOperationExecutionCancellationInfo

NexusOperationExecutionCancellationInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NexusOperationExecutionCancellationInfo

NexusOperationExecutionCancellationInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object