PollOperationState interface

Paket:

@azure/keyvault-secrets

PollOperationState enthält eine liste der kleinsten Eigenschaften, die zum Definieren von Abfragevorgängen mit langer Ausführungszeit erforderlich sind.

Während die Poller-Klasse als lokaler Steuerungsmechanismus zum Starten des Auslösens, Wartens und Abbrechen eines vorgangs mit langer Ausführung funktioniert, dokumentiert PollOperationState den Status des Remotevorgangs mit langer Ausführungsdauer.

Es sollte mindestens aktualisiert werden, wenn der Vorgang gestartet wird, wenn er abgeschlossen ist und wenn er abgebrochen wird. Implementierungen können jedoch eine beliebige andere Anzahl von Eigenschaften aufweisen, die aus anderen Gründen aktualisiert werden können.

Eigenschaften

error	Ist vorhanden, wenn für den Vorgang ein Fehler aufgetreten ist.
isCancelled	True, wenn der Vorgang abgebrochen wurde.
isCompleted	True, wenn der Vorgang abgeschlossen wurde.
isStarted	True, wenn der Vorgang gestartet wurde.
result	Ist vorhanden, wenn der Vorgang als Ergebnis eines erwarteten Typs abgeschlossen wurde.

Details zur Eigenschaft

error

Ist vorhanden, wenn für den Vorgang ein Fehler aufgetreten ist.

error?: Error

Eigenschaftswert

Error

isCancelled

True, wenn der Vorgang abgebrochen wurde.

isCancelled?: boolean

Eigenschaftswert

boolean

isCompleted

True, wenn der Vorgang abgeschlossen wurde.

isCompleted?: boolean

Eigenschaftswert

boolean

isStarted

True, wenn der Vorgang gestartet wurde.

isStarted?: boolean

Eigenschaftswert

boolean

result

Ist vorhanden, wenn der Vorgang als Ergebnis eines erwarteten Typs abgeschlossen wurde.

result?: TResult

Eigenschaftswert

TResult