Class: NexusOperationExecutionInfo
nexus.v1.NexusOperationExecutionInfo
Full current state of a standalone Nexus operation, as of the time of the request.
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: null | $Properties
NexusOperationExecutionInfo cancellationInfo.
closeTime
• Optional closeTime: null | $Properties
Time when the operation transitioned to a closed state.
endpoint
• endpoint: string
Endpoint name, resolved to a URL via the cluster's endpoint registry.
executionDuration
• Optional executionDuration: null | $Properties
Elapsed time from schedule_time to now for running operations or to close_time for closed operations, including all attempts and backoff between attempts.
expirationTime
• Optional expirationTime: null | $Properties
Scheduled time + schedule to close timeout.
identity
• identity: string
The identity of the client who started this operation.
lastAttemptCompleteTime
• Optional lastAttemptCompleteTime: null | $Properties
The time when the last attempt completed.
lastAttemptFailure
• Optional lastAttemptFailure: null | $Properties
The last attempt's failure, if any.
links
• links: $Properties[]
Links attached by the handler of this operation on start or completion.
nextAttemptScheduleTime
• Optional nextAttemptScheduleTime: null | $Properties
The time when the next attempt is scheduled.
nexusHeader
• nexusHeader: Object
Header for context propagation and tracing purposes.
Index signature
▪ [k: string]: string
operation
• operation: string
Operation name.
operationId
• operationId: string
Unique identifier of this Nexus operation within its namespace along with run ID (below).
operationToken
• operationToken: string
Operation token. Only set for asynchronous operations after a successful StartOperation call.
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.
runId
• runId: string
NexusOperationExecutionInfo runId.
scheduleTime
• Optional scheduleTime: null | $Properties
Time the operation was originally scheduled via a StartNexusOperation request.
scheduleToCloseTimeout
• Optional scheduleToCloseTimeout: null | $Properties
Schedule-to-close timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
scheduleToStartTimeout
• Optional scheduleToStartTimeout: null | $Properties
Schedule-to-start timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
searchAttributes
• Optional searchAttributes: null | $Properties
NexusOperationExecutionInfo searchAttributes.
service
• service: string
Service name.
startToCloseTimeout
• Optional startToCloseTimeout: null | $Properties
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
More detailed breakdown of NEXUS_OPERATION_EXECUTION_STATUS_RUNNING.
stateSizeBytes
• stateSizeBytes: Long
Updated once on scheduled and once on terminal status.
stateTransitionCount
• stateTransitionCount: Long
Incremented each time the operation's state is mutated in persistence.
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.
userMetadata
• Optional userMetadata: null | $Properties
Metadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.
Methods
toJSON
▸ toJSON(): Object
Converts this NexusOperationExecutionInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NexusOperationExecutionInfo & $Shape
Creates a new NexusOperationExecutionInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
NexusOperationExecutionInfo & $Shape
NexusOperationExecutionInfo instance
▸ create(properties?): NexusOperationExecutionInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): NexusOperationExecutionInfo & $Shape
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 & $Shape
NexusOperationExecutionInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NexusOperationExecutionInfo & $Shape
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 & $Shape
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 | $Properties | 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 | $Properties | 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
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