PollOperationState interface

  • Reference
Package:
@azure/keyvault-keys

PollOperationState contains an opinionated list of the smallest set of properties needed to define any long running operation poller.

While the Poller class works as the local control mechanism to start triggering, wait for, and potentially cancel a long running operation, the PollOperationState documents the status of the remote long running operation.

It should be updated at least when the operation starts, when it's finished, and when it's cancelled. Though, implementations can have any other number of properties that can be updated by other reasons.

Properties

error

Will exist if the operation encountered any error.
isCancelled

True if the operation has been cancelled.
isCompleted

True if the operation has been completed.
isStarted

True if the operation has started.
result

Will exist if the operation concluded in a result of an expected type.

Property Details

error

Will exist if the operation encountered any error.

error?: Error

Property Value

Error

isCancelled

True if the operation has been cancelled.

isCancelled?: boolean

Property Value

boolean

isCompleted

True if the operation has been completed.

isCompleted?: boolean

Property Value

boolean

isStarted

True if the operation has started.

isStarted?: boolean

Property Value

boolean

result

Will exist if the operation concluded in a result of an expected type.

result?: TResult

Property Value

TResult