PollOperationState interface

Pakiet:

@azure/keyvault-secrets

PollOperationState zawiera listę najdrobniejszych zestawów 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. Jednak implementacje mogą mieć dowolną inną liczbę właściwości, które mogą być aktualizowane z innych powodów.

Właściwości

error	Będzie istnieć, jeśli operacja napotkała jakikolwiek błąd.
isCancelled	Prawda, jeśli operacja została anulowana.
isCompleted	Prawda, jeśli operacja została ukończona.
isStarted	Prawda, jeśli operacja została uruchomiona.
result	Będzie istnieć, jeśli operacja zakończyła się wynikiem 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

Prawda, jeśli operacja została anulowana.

isCancelled?: boolean

Wartość właściwości

boolean

isCompleted

Prawda, jeśli operacja została ukończona.

isCompleted?: boolean

Wartość właściwości

boolean

isStarted

Prawda, jeśli operacja została uruchomiona.

isStarted?: boolean

Wartość właściwości

boolean

result

Będzie istnieć, jeśli operacja zakończyła się wynikiem oczekiwanego typu.

result?: TResult

Wartość właściwości

TResult