Class: PendingNexusOperationInfo

PendingNexusOperationInfo contains the state of a pending Nexus operation.

Properties

attempt

attempt: number

The number of attempts made to deliver the start operation request. This number is approximate, it is incremented when a task is added to the history queue. In practice, there could be more attempts if a task is executed but fails to commit, or less attempts if a task was never executed.

---

blockedReason

blockedReason: string

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

---

cancellationInfo?

optional cancellationInfo?: $Properties | null

PendingNexusOperationInfo cancellationInfo.

---

endpoint

endpoint: string

Endpoint name. Resolved to a URL via the cluster's endpoint registry.

---

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.

---

operation

operation: string

Operation name.

---

operationId

operationId: string

Operation ID. Only set for asynchronous operations after a successful StartOperation call.

Deprecated. Renamed to operation_token.

---

operationToken

operationToken: string

Operation token. Only set for asynchronous operations after a successful StartOperation call.

---

scheduledEventId

scheduledEventId: Long

The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the DescribeWorkflowExecution response with workflow history.

---

scheduledTime?

optional scheduledTime?: $Properties | null

The time when the operation was scheduled.

---

scheduleToCloseTimeout?

optional scheduleToCloseTimeout?: $Properties | null

Schedule-to-close timeout for this operation. This is the only timeout settable by a workflow. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

---

scheduleToStartTimeout?

optional scheduleToStartTimeout?: $Properties | null

Schedule-to-start timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

---

service

service: string

Service name.

---

startToCloseTimeout?

optional startToCloseTimeout?: $Properties | null

Start-to-close timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

---

state

state: PendingNexusOperationState

PendingNexusOperationInfo state.

Methods

toJSON()

toJSON(): object

Converts this PendingNexusOperationInfo to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): PendingNexusOperationInfo & $Shape

Creates a new PendingNexusOperationInfo instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

PendingNexusOperationInfo & $Shape

PendingNexusOperationInfo instance

Call Signature

static create(properties?): PendingNexusOperationInfo

Creates a new PendingNexusOperationInfo instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

PendingNexusOperationInfo

PendingNexusOperationInfo instance

---

decode()

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

Decodes a PendingNexusOperationInfo 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

PendingNexusOperationInfo & $Shape

PendingNexusOperationInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): PendingNexusOperationInfo & $Shape

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

PendingNexusOperationInfo & $Shape

PendingNexusOperationInfo

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

Parameters

message

$Properties

PendingNexusOperationInfo message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

PendingNexusOperationInfo message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): PendingNexusOperationInfo

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

Parameters

object

Plain object

Returns

PendingNexusOperationInfo

PendingNexusOperationInfo

---

toObject()

static toObject(message, options?): object

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

Parameters

message

PendingNexusOperationInfo

PendingNexusOperationInfo

options?

IConversionOptions

Conversion options

Returns

object

Plain object