PollOperationState interface

  • Referens
Paket:
@azure/keyvault-secrets

PollOperationState innehåller en åsiktslista över den minsta uppsättningen egenskaper som behövs för att definiera en tidskrävande åtgärdsbestämning.

Medan Poller-klassen fungerar som den lokala kontrollmekanismen för att börja utlösa, vänta på och eventuellt avbryta en tidskrävande åtgärd, dokumenterar PollOperationState statusen för fjärråtgärden som körs länge.

Den bör uppdateras åtminstone när åtgärden startas, när den är klar och när den avbryts. Implementeringar kan dock ha valfritt annat antal egenskaper som kan uppdateras av andra orsaker.

Egenskaper

error

Kommer att finnas om åtgärden påträffade något fel.
isCancelled

Sant om åtgärden har avbrutits.
isCompleted

Sant om åtgärden har slutförts.
isStarted

Sant om åtgärden har startat.
result

Kommer att finnas om åtgärden avslutades till följd av en förväntad typ.

Egenskapsinformation

error

Kommer att finnas om åtgärden påträffade något fel.

error?: Error

Egenskapsvärde

Error

isCancelled

Sant om åtgärden har avbrutits.

isCancelled?: boolean

Egenskapsvärde

boolean

isCompleted

Sant om åtgärden har slutförts.

isCompleted?: boolean

Egenskapsvärde

boolean

isStarted

Sant om åtgärden har startat.

isStarted?: boolean

Egenskapsvärde

boolean

result

Kommer att finnas om åtgärden avslutades till följd av en förväntad typ.

result?: TResult

Egenskapsvärde

TResult