Skip to main content

Interface: $Properties

Properties of a NexusOperationExecutionInfo.

Extended by​

Properties​

attempt?​

optional attempt?: number | null

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?: string | null

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

cancellationInfo?​

optional cancellationInfo?: $Properties | null

NexusOperationExecutionInfo cancellationInfo

closeTime?​

optional closeTime?: $Properties | null

Time when the operation transitioned to a closed state.

endpoint?​

optional endpoint?: string | null

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

executionDuration?​

optional executionDuration?: $Properties | null

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?: $Properties | null

Scheduled time + schedule to close timeout.

identity?​

optional identity?: string | null

The identity of the client who started this operation.

lastAttemptCompleteTime?​

optional lastAttemptCompleteTime?: $Properties | null

The time when the last attempt completed.

lastAttemptFailure?​

optional lastAttemptFailure?: $Properties | null

The last attempt's failure, if any.

optional links?: $Properties[] | null

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

nextAttemptScheduleTime?​

optional nextAttemptScheduleTime?: $Properties | null

The time when the next attempt is scheduled.

nexusHeader?​

optional nexusHeader?: {[k: string]: string; } | null

Header for context propagation and tracing purposes.

operation?​

optional operation?: string | null

Operation name.

operationId?​

optional operationId?: string | null

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

operationToken?​

optional operationToken?: string | null

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

requestId?​

optional requestId?: string | null

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?: string | null

NexusOperationExecutionInfo runId

scheduleTime?​

optional scheduleTime?: $Properties | null

Time the operation was originally scheduled via a StartNexusOperation request.

scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: $Properties | null

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?: $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. --)

searchAttributes?​

optional searchAttributes?: $Properties | null

NexusOperationExecutionInfo searchAttributes

service?​

optional service?: string | null

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?​

optional state?: PendingNexusOperationState | null

More detailed breakdown of NEXUS_OPERATION_EXECUTION_STATUS_RUNNING.

stateSizeBytes?​

optional stateSizeBytes?: Long | null

Updated once on scheduled and once on terminal status.

stateTransitionCount?​

optional stateTransitionCount?: Long | null

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

status?​

optional status?: NexusOperationExecutionStatus | null

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?: $Properties | null

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