PollOperationState interface

套件:

@azure/keyvault-secrets

PollOperationState 包含定義任何長時間執行之作業輪詢器所需的最小屬性集意見清單。

雖然 Poller 類別可作為開始觸發、等候及可能取消長時間執行作業的本機控制機制，但 PollOperationState 會記載遠端長時間執行作業的狀態。

它應該至少在作業啟動時、完成時以及取消時更新。 不過，實作可以有任何其他數目的屬性，這些屬性可能會因為其他原因而更新。

屬性

error	如果作業發生任何錯誤，就會存在。
isCancelled	如果作業已取消，則為 True。
isCompleted	如果作業已完成，則為 True。
isStarted	如果作業已啟動，則為 True。
result	如果作業以預期型別的結果結束，就會存在。

屬性詳細資料

error

如果作業發生任何錯誤，就會存在。

error?: Error

屬性值

Error

isCancelled

如果作業已取消，則為 True。

isCancelled?: boolean

屬性值

boolean

isCompleted

如果作業已完成，則為 True。

isCompleted?: boolean

屬性值

boolean

isStarted

如果作業已啟動，則為 True。

isStarted?: boolean

屬性值

boolean

result

如果作業以預期型別的結果結束，就會存在。

result?: TResult

屬性值

TResult