Skip to main content

Interface: $Properties

v1.NexusOperationExecutionInfo.$Properties

Properties of a NexusOperationExecutionInfo.

Hierarchy​

Properties​

attempt​

• Optional attempt: null | 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​

• Optional blockedReason: null | 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​

• Optional endpoint: null | 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​

• Optional identity: null | 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.

• Optional links: null | $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​

• Optional nexusHeader: null | { [k: string]: string; }

Header for context propagation and tracing purposes.

operation​

• Optional operation: null | string

Operation name.

operationId​

• Optional operationId: null | string

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

operationToken​

• Optional operationToken: null | string

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

requestId​

• Optional requestId: null | 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​

• Optional runId: null | 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​

• Optional service: null | 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​

• Optional state: null | PendingNexusOperationState

More detailed breakdown of NEXUS_OPERATION_EXECUTION_STATUS_RUNNING.

stateSizeBytes​

• Optional stateSizeBytes: null | Long

Updated once on scheduled and once on terminal status.

stateTransitionCount​

• Optional stateTransitionCount: null | Long

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

status​

• Optional status: null | 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.