LROPoller クラス

実行時間の長い操作の Poller。

継承

Generic

LROPoller

コンストラクター

LROPoller(client: Any, initial_response: Any, deserialization_callback: Callable[[Any], PollingReturnType_co], polling_method: PollingMethod[PollingReturnType_co])

パラメーター

名前	説明
client 必須	PipelineClient パイプライン サービス クライアント
initial_response 必須	PipelineResponse 最初の呼び出し応答
deserialization_callback 必須	callable または <xref:msrest.serialization.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 少なくとも 1 つの引数 (完了した LongRunningOperation) を受け取るコールバック関数。

continuation_token

ポーリングを後で再起動できる継続トークンを返します。

continuation_token() -> str

戻り値

型	説明
str	不透明な継続トークン

done

実行時間の長い操作の状態を確認します。

done() -> bool

戻り値

型	説明
bool	プロセスが完了した場合は 'True'、それ以外の場合は 'False' です。

from_continuation_token

from_continuation_token(polling_method: PollingMethod[PollingReturnType_co], continuation_token: str, **kwargs: Any) -> LROPoller[PollingReturnType_co]

パラメーター

名前	説明
polling_method 必須
continuation_token 必須

polling_method

このポーリング に関連付けられているポーリング メソッドを返します。

polling_method() -> PollingMethod[PollingReturnType_co]

戻り値

型	説明
PollingMethod	ポーリング メソッド

remove_done_callback

実行時間の長い操作からコールバックを削除します。

remove_done_callback(func: Callable) -> None

パラメーター

名前	説明
func 必須	callable コールバックから削除される関数。

例外

型	説明
ValueError	実行時間の長い操作が既に完了している場合は 。

result

実行時間の長い操作の結果、または指定したタイムアウト後に使用可能な結果を返します。

result(timeout: float | None = None) -> PollingReturnType_co

パラメーター

名前	説明
timeout	float 制御を取り戻す前に待機する期間。 既定値: None

戻り値

型	説明
any, None	実行時間の長い操作の逆シリアル化されたリソース (使用可能な場合)。

例外

型	説明
HttpResponseError	クエリに関するサーバーの問題。

status

現在の状態文字列を返します。

status() -> str

戻り値

型	説明
str	現在の状態文字列

wait

指定した時間、実行時間の長い操作を待機します。 この呼び出しがタイムアウトで終了した場合は、"done()" メソッドを使用してチェックできます。

wait(timeout: float | None = None) -> None

パラメーター

名前	説明
timeout 必須	float 実行時間の長い操作が完了するまで待機する期間 (秒単位)。

例外

型	説明
HttpResponseError	クエリに関するサーバーの問題。