Class: NexusOperationExecutionInfo

nexus.v1.NexusOperationExecutionInfo

Full current state of a standalone Nexus operation, as of the time of the request.

Implements

• INexusOperationExecutionInfo

Constructors

constructor

• new NexusOperationExecutionInfo(properties?): NexusOperationExecutionInfo

Constructs a new NexusOperationExecutionInfo.

Parameters

Name	Type	Description
properties?	INexusOperationExecutionInfo	Properties to set

Returns

NexusOperationExecutionInfo

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.

Implementation of

INexusOperationExecutionInfo.attempt

---

blockedReason

• blockedReason: string

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

Implementation of

INexusOperationExecutionInfo.blockedReason

---

cancellationInfo

• Optional cancellationInfo: null | INexusOperationExecutionCancellationInfo

NexusOperationExecutionInfo cancellationInfo.

Implementation of

INexusOperationExecutionInfo.cancellationInfo

---

closeTime

• Optional closeTime: null | ITimestamp

Time when the operation transitioned to a closed state.

Implementation of

INexusOperationExecutionInfo.closeTime

---

endpoint

• endpoint: string

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

Implementation of

INexusOperationExecutionInfo.endpoint

---

executionDuration

• Optional executionDuration: null | IDuration

Elapsed time from schedule_time to now for running operations or to close_time for closed operations, including all attempts and backoff between attempts.

Implementation of

INexusOperationExecutionInfo.executionDuration

---

expirationTime

• Optional expirationTime: null | ITimestamp

Scheduled time + schedule to close timeout.

Implementation of

INexusOperationExecutionInfo.expirationTime

---

identity

• identity: string

The identity of the client who started this operation.

Implementation of

INexusOperationExecutionInfo.identity

---

lastAttemptCompleteTime

• Optional lastAttemptCompleteTime: null | ITimestamp

The time when the last attempt completed.

Implementation of

INexusOperationExecutionInfo.lastAttemptCompleteTime

---

lastAttemptFailure

• Optional lastAttemptFailure: null | IFailure

The last attempt's failure, if any.

Implementation of

INexusOperationExecutionInfo.lastAttemptFailure

---

links

• links: ILink[]

Links attached by the handler of this operation on start or completion.

Implementation of

INexusOperationExecutionInfo.links

---

nextAttemptScheduleTime

• Optional nextAttemptScheduleTime: null | ITimestamp

The time when the next attempt is scheduled.

Implementation of

INexusOperationExecutionInfo.nextAttemptScheduleTime

---

nexusHeader

• nexusHeader: Object

Header for context propagation and tracing purposes.

Index signature

▪ [k: string]: string

Implementation of

INexusOperationExecutionInfo.nexusHeader

---

operation

• operation: string

Operation name.

Implementation of

INexusOperationExecutionInfo.operation

---

operationId

• operationId: string

Unique identifier of this Nexus operation within its namespace along with run ID (below).

Implementation of

INexusOperationExecutionInfo.operationId

---

operationToken

• operationToken: string

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

Implementation of

INexusOperationExecutionInfo.operationToken

---

requestId

• requestId: string

Server-generated request ID used as an idempotency token when submitting start requests to the handler. Distinct from the request_id in StartNexusOperationRequest, which is the caller-side idempotency key for the StartNexusOperation RPC itself.

Implementation of

INexusOperationExecutionInfo.requestId

---

runId

• runId: string

NexusOperationExecutionInfo runId.

Implementation of

INexusOperationExecutionInfo.runId

---

scheduleTime

• Optional scheduleTime: null | ITimestamp

Time the operation was originally scheduled via a StartNexusOperation request.

Implementation of

INexusOperationExecutionInfo.scheduleTime

---

scheduleToCloseTimeout

• Optional scheduleToCloseTimeout: null | IDuration

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

Implementation of

INexusOperationExecutionInfo.scheduleToCloseTimeout

---

scheduleToStartTimeout

• Optional scheduleToStartTimeout: null | IDuration

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

Implementation of

INexusOperationExecutionInfo.scheduleToStartTimeout

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

NexusOperationExecutionInfo searchAttributes.

Implementation of

INexusOperationExecutionInfo.searchAttributes

---

service

• service: string

Service name.

Implementation of

INexusOperationExecutionInfo.service

---

startToCloseTimeout

• Optional startToCloseTimeout: null | IDuration

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

Implementation of

INexusOperationExecutionInfo.startToCloseTimeout

---

state

• state: PendingNexusOperationState

More detailed breakdown of NEXUS_OPERATION_EXECUTION_STATUS_RUNNING.

Implementation of

INexusOperationExecutionInfo.state

---

stateTransitionCount

• stateTransitionCount: Long

Incremented each time the operation's state is mutated in persistence.

Implementation of

INexusOperationExecutionInfo.stateTransitionCount

---

status

• status: NexusOperationExecutionStatus

A general status for this operation, indicates whether it is currently running or in one of the terminal statuses. Updated once when the operation is originally scheduled, and again when it reaches a terminal status.

Implementation of

INexusOperationExecutionInfo.status

---

userMetadata

• Optional userMetadata: null | IUserMetadata

Metadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.

Implementation of

INexusOperationExecutionInfo.userMetadata

Methods

toJSON

▸ toJSON(): Object

Converts this NexusOperationExecutionInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): NexusOperationExecutionInfo

Creates a new NexusOperationExecutionInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	INexusOperationExecutionInfo	Properties to set

Returns

NexusOperationExecutionInfo

NexusOperationExecutionInfo instance

---

decode

▸ decode(reader, length?): NexusOperationExecutionInfo

Decodes a NexusOperationExecutionInfo message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

NexusOperationExecutionInfo

NexusOperationExecutionInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): NexusOperationExecutionInfo

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

NexusOperationExecutionInfo

NexusOperationExecutionInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

Encodes the specified NexusOperationExecutionInfo message. Does not implicitly temporal.api.nexus.v1.NexusOperationExecutionInfo.verify|verify messages.

Parameters

Name	Type	Description
message	INexusOperationExecutionInfo	NexusOperationExecutionInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	INexusOperationExecutionInfo	NexusOperationExecutionInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): NexusOperationExecutionInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

NexusOperationExecutionInfo

NexusOperationExecutionInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for NexusOperationExecutionInfo

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	NexusOperationExecutionInfo	NexusOperationExecutionInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object