Skip to main content

Interface: IPendingNexusOperationInfo

Properties of a PendingNexusOperationInfo.

Extends​

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.

Inherited from​

$Properties.attempt

blockedReason?​

optional blockedReason?: string | null

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

Inherited from​

$Properties.blockedReason

cancellationInfo?​

optional cancellationInfo?: $Properties | null

PendingNexusOperationInfo cancellationInfo

Inherited from​

$Properties.cancellationInfo

endpoint?​

optional endpoint?: string | null

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

Inherited from​

$Properties.endpoint

lastAttemptCompleteTime?​

optional lastAttemptCompleteTime?: $Properties | null

The time when the last attempt completed.

Inherited from​

$Properties.lastAttemptCompleteTime

lastAttemptFailure?​

optional lastAttemptFailure?: $Properties | null

The last attempt's failure, if any.

Inherited from​

$Properties.lastAttemptFailure

nextAttemptScheduleTime?​

optional nextAttemptScheduleTime?: $Properties | null

The time when the next attempt is scheduled.

Inherited from​

$Properties.nextAttemptScheduleTime

operation?​

optional operation?: string | null

Operation name.

Inherited from​

$Properties.operation

operationId?​

optional operationId?: string | null

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

Deprecated. Renamed to operation_token.

Inherited from​

$Properties.operationId

operationToken?​

optional operationToken?: string | null

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

Inherited from​

$Properties.operationToken

scheduledEventId?​

optional scheduledEventId?: Long | null

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

Inherited from​

$Properties.scheduledEventId

scheduledTime?​

optional scheduledTime?: $Properties | null

The time when the operation was scheduled.

Inherited from​

$Properties.scheduledTime

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. --)

Inherited from​

$Properties.scheduleToCloseTimeout

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. --)

Inherited from​

$Properties.scheduleToStartTimeout

service?​

optional service?: string | null

Service name.

Inherited from​

$Properties.service

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. --)

Inherited from​

$Properties.startToCloseTimeout

state?​

optional state?: PendingNexusOperationState | null

PendingNexusOperationInfo state

Inherited from​

$Properties.state