PollOperationState interface

Pakiet:

@azure/keyvault-keys

PollOperationState zawiera listę z opiniami najmniejszego zestawu właściwości potrzebnych do zdefiniowania dowolnej długotrwałej operacji poller.

Podczas gdy klasa Poller działa jako lokalny mechanizm sterowania, aby rozpocząć wyzwalanie, czekać i potencjalnie anulować długotrwałą operację, PollOperationState dokumentuje stan zdalnej długotrwałej operacji.

Powinna zostać zaktualizowana co najmniej po rozpoczęciu operacji, zakończeniu i anulowaniu. Chociaż implementacje mogą mieć dowolną inną liczbę właściwości, które można zaktualizować z innych powodów.

Właściwości

error	Będzie istnieć, jeśli operacja napotkała jakikolwiek błąd.
isCancelled	Wartość True, jeśli operacja została anulowana.
isCompleted	Wartość True, jeśli operacja została ukończona.
isStarted	Wartość True, jeśli operacja została uruchomiona.
result	Będzie istnieć, jeśli operacja została zakończona w wyniku oczekiwanego typu.

Szczegóły właściwości

error

Będzie istnieć, jeśli operacja napotkała jakikolwiek błąd.

error?: Error

Wartość właściwości

Error

isCancelled

Wartość True, jeśli operacja została anulowana.

isCancelled?: boolean

Wartość właściwości

boolean

isCompleted

Wartość True, jeśli operacja została ukończona.

isCompleted?: boolean

Wartość właściwości

boolean

isStarted

Wartość True, jeśli operacja została uruchomiona.

isStarted?: boolean

Wartość właściwości

boolean

result

Będzie istnieć, jeśli operacja została zakończona w wyniku oczekiwanego typu.

result?: TResult

Wartość właściwości

TResult