LROPoller 類別

  • 參考

長時間執行的作業輪詢器。

繼承
Generic
LROPoller

建構函式

LROPoller(client: Any, initial_response: Any, deserialization_callback: Callable, polling_method: azure.core.polling._poller.PollingMethod[PollingReturnType])

參數

client
PipelineClient
必要

管線服務用戶端

initial_response
PipelineResponse
必要

初始呼叫回應

deserialization_callback
callable 或 Model
必要

回呼，接受 Response 並傳回已還原序列化的物件。 如果提供 Model 的子類別，這會傳遞「還原序列化」作為回呼。

polling_method
PollingMethod
必要

要採用的輪詢策略

方法

add_done_callback

新增回呼函式，以在長時間執行的作業完成之後執行-不論作業的狀態為何。
continuation_token

傳回允許稍後重新開機輪詢器的接續權杖。
done

檢查長時間執行作業的狀態。
from_continuation_token
polling_method

傳回與此輪詢器相關聯的輪詢方法。
remove_done_callback

從長時間執行的作業中移除回呼。
result

傳回長時間執行作業的結果，或指定逾時之後可用的結果。
status

傳回目前的狀態字串。
wait

等候長時間執行的作業指定時間長度。 您可以使用 「done () 」 方法來檢查此呼叫是否以逾時結束。

add_done_callback

新增回呼函式，以在長時間執行的作業完成之後執行-不論作業的狀態為何。

add_done_callback(func: Callable) -> None

參數

func
callable
必要

至少接受一個引數的回呼函式，即已完成的 LongRunningOperation。

continuation_token

傳回允許稍後重新開機輪詢器的接續權杖。

continuation_token() -> str

傳回

不透明接續權杖

傳回類型

str

done

檢查長時間執行作業的狀態。

done() -> bool

傳回

如果程式已完成，則為 'True'，否則為 'False'。

傳回類型

bool

from_continuation_token 

from_continuation_token(polling_method: azure.core.polling._poller.PollingMethod[PollingReturnType], continuation_token: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[PollingReturnType]

參數

polling_method
必要
continuation_token
必要

polling_method

傳回與此輪詢器相關聯的輪詢方法。

polling_method() -> azure.core.polling._poller.PollingMethod[PollingReturnType]

remove_done_callback

從長時間執行的作業中移除回呼。

remove_done_callback(func: Callable) -> None

參數

func
callable
必要

要從回呼中移除的函式。

例外狀況

ValueError

如果長時間執行的作業已完成，則為 。

result

傳回長時間執行作業的結果，或指定逾時之後可用的結果。

result(timeout: Optional[int] = None) -> PollingReturnType

參數

timeout
預設值: None

傳回

如果有，則為長時間執行作業的還原序列化資源。

例外狀況

HttpResponseError

查詢的伺服器問題。

status

傳回目前的狀態字串。

status() -> str

傳回

目前的狀態字串

傳回類型

str

wait

等候長時間執行的作業指定時間長度。 您可以使用 「done () 」 方法來檢查此呼叫是否以逾時結束。

wait(timeout: Optional[float] = None) -> None

參數

timeout
float
必要

等候長時間執行的作業在幾秒內完成 () 。

例外狀況

HttpResponseError

查詢的伺服器問題。