Skip to main content

Interface: IPendingNexusOperationInfo

workflow.v1.IPendingNexusOperationInfo

Properties of a PendingNexusOperationInfo.

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.

Inherited from​

$Properties.attempt

blockedReason​

• Optional blockedReason: null | string

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

Inherited from​

$Properties.blockedReason

cancellationInfo​

• Optional cancellationInfo: null | $Properties

PendingNexusOperationInfo cancellationInfo

Inherited from​

$Properties.cancellationInfo

endpoint​

• Optional endpoint: null | string

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

Inherited from​

$Properties.endpoint

lastAttemptCompleteTime​

• Optional lastAttemptCompleteTime: null | $Properties

The time when the last attempt completed.

Inherited from​

$Properties.lastAttemptCompleteTime

lastAttemptFailure​

• Optional lastAttemptFailure: null | $Properties

The last attempt's failure, if any.

Inherited from​

$Properties.lastAttemptFailure

nextAttemptScheduleTime​

• Optional nextAttemptScheduleTime: null | $Properties

The time when the next attempt is scheduled.

Inherited from​

$Properties.nextAttemptScheduleTime

operation​

• Optional operation: null | string

Operation name.

Inherited from​

$Properties.operation

operationId​

• Optional operationId: null | string

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

Deprecated. Renamed to operation_token.

Inherited from​

$Properties.operationId

operationToken​

• Optional operationToken: null | string

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

Inherited from​

$Properties.operationToken

scheduleToCloseTimeout​

• Optional scheduleToCloseTimeout: null | $Properties

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

Inherited from​

$Properties.scheduleToStartTimeout

scheduledEventId​

• Optional scheduledEventId: null | Long

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

The time when the operation was scheduled.

Inherited from​

$Properties.scheduledTime

service​

• Optional service: null | string

Service name.

Inherited from​

$Properties.service

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

Inherited from​

$Properties.startToCloseTimeout

state​

• Optional state: null | PendingNexusOperationState

PendingNexusOperationInfo state

Inherited from​

$Properties.state