LROPoller 類別
長時間執行的作業輪詢器。
- 繼承
-
LROPoller
建構函式
LROPoller(client: Any, initial_response: Any, deserialization_callback: Callable[[Any], PollingReturnType_co], polling_method: PollingMethod[PollingReturnType_co])參數
| 名稱 | Description |
|---|---|
|
client
必要
|
管線服務用戶端 |
|
initial_response
必要
|
初始呼叫回應 |
|
deserialization_callback
必要
|
callable 或
<xref:msrest.serialization.Model>
採用 Response 並傳回已還原序列化物件的回呼。 如果指定 Model 的子類別，這會傳遞「還原序列化」作為回呼。 |
|
polling_method
必要
|
要採用的輪詢策略 |
方法
| 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參數
| 名稱 | Description |
|---|---|
|
func
必要
|
至少接受一個引數的回呼函式，即已完成的 LongRunningOperation。 |
continuation_token
done
from_continuation_token
from_continuation_token(polling_method: PollingMethod[PollingReturnType_co], continuation_token: str, **kwargs: Any) -> LROPoller[PollingReturnType_co]參數
| 名稱 | Description |
|---|---|
|
polling_method
必要
|
|
|
continuation_token
必要
|
|
polling_method
傳回與此輪詢器相關聯的輪詢方法。
polling_method() -> PollingMethod[PollingReturnType_co]傳回
| 類型 | Description |
|---|---|
|
輪詢方法 |
remove_done_callback
從長時間執行的作業中移除回呼。
remove_done_callback(func: Callable) -> None參數
| 名稱 | Description |
|---|---|
|
func
必要
|
要從回呼中移除的函式。 |
例外狀況
| 類型 | Description |
|---|---|
|
如果長時間執行的作業已完成，則為 。 |
result
傳回長時間執行作業的結果，或指定逾時之後可用的結果。
result(timeout: float | None = None) -> PollingReturnType_co參數
| 名稱 | Description |
|---|---|
|
timeout
|
在返回控制之前等待的時間週期。 預設值: None
|
傳回
| 類型 | Description |
|---|---|
|
any,
|
如果有的話，長時間執行作業的還原序列化資源。 |
例外狀況
| 類型 | Description |
|---|---|
|
查詢的伺服器問題。 |
status
wait
等候長時間執行的作業，以指定的時間長度。 您可以使用 「done () 」 方法來檢查此呼叫是否以逾時結束。
wait(timeout: float | None = None) -> None參數
| 名稱 | Description |
|---|---|
|
timeout
必要
|
等候長時間執行的作業在幾秒內完成 () 。 |
例外狀況
| 類型 | Description |
|---|---|
|
查詢的伺服器問題。 |
