PollOperationState interface

Pakket:

@azure/keyvault-keys

PollOperationState bevat een aangepaste lijst met de kleinste set eigenschappen die nodig zijn om een poller voor langdurige bewerkingen te definiëren.

Terwijl de Poller-klasse werkt als het lokale controlemechanisme om te beginnen met het activeren, wachten op en mogelijk annuleren van een langlopende bewerking, documenteert pollOperationState de status van de externe langlopende bewerking.

Deze moet ten minste worden bijgewerkt wanneer de bewerking wordt gestart, voltooid en geannuleerd. Implementaties kunnen echter een ander aantal eigenschappen hebben dat om andere redenen kan worden bijgewerkt.

Eigenschappen

error	Bestaat als er een fout is opgetreden bij de bewerking.
isCancelled	True als de bewerking is geannuleerd.
isCompleted	True als de bewerking is voltooid.
isStarted	True als de bewerking is gestart.
result	Bestaat als de bewerking is afgesloten in een resultaat van een verwacht type.

Eigenschapdetails

error

Bestaat als er een fout is opgetreden bij de bewerking.

error?: Error

Waarde van eigenschap

Error

isCancelled

True als de bewerking is geannuleerd.

isCancelled?: boolean

Waarde van eigenschap

boolean

isCompleted

True als de bewerking is voltooid.

isCompleted?: boolean

Waarde van eigenschap

boolean

isStarted

True als de bewerking is gestart.

isStarted?: boolean

Waarde van eigenschap

boolean

result

Bestaat als de bewerking is afgesloten in een resultaat van een verwacht type.

result?: TResult

Waarde van eigenschap

TResult