@azure/core-lro package
インターフェイス
| CreateHttpPollerOptions |
|
| OperationConfig |
操作をポーリングし、終了したかどうかを確認する方法の構成。 |
| OperationResponse |
LRO の応答の型。 |
| OperationState |
ポーリングツールは、実行時間の長い操作のトリガーと待機を開始するローカル制御メカニズムとして機能しますが、OperationState は、リモートの実行時間の長い操作の状態を文書化します。 各ポーリングの後に更新されます。 |
| PollerLike |
操作のポーリング者。 |
| RawRequest |
生の要求の単純な型。 |
| RawResponse |
生の応答の単純な型。 |
| RunningOperation |
実行時間の長い操作の説明。 |
型エイリアス
| CancelOnProgress |
CancelOnProgress は、Poller の onProgress メソッドの戻り値として使用されます。 ユーザーが onProgress を呼び出すときは、ポーリング操作が更新されるたびに受信した新しいデータを含むコールバックとして呼び出される関数を渡す必要があります。 onProgress は、それ以上の更新が元のコールバックに到達するのを防ぐ関数を返します。 |
| OperationStatus |
操作が任意の時点に存在する可能性のある状態のセット。 |
| ResourceLocationConfig |
Swagger の LRO 拡張機能で指定されている場合の、LRO の結果の潜在的な場所。 |
| RestorableOperationState |
復元可能な実行時間の長い操作の種類。 |
関数
| create |
実行時間の長い操作をポーリングするために使用できるポーリング ャーを作成します。 |
| deserialize |
状態を逆シリアル化します |
関数の詳細
createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
実行時間の長い操作をポーリングするために使用できるポーリング ャーを作成します。
function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>パラメーター
- lro
-
RunningOperation<unknown>
実行時間の長い操作の説明
- options
-
CreateHttpPollerOptions<TResult, TState>
poller を構成するためのオプション
戻り値
PollerLike<TState, TResult>
初期化されたポーリング ャー
deserializeState<TResult, TState>(string)
状態を逆シリアル化します
function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>パラメーター
- serializedState
-
string
戻り値
RestorableOperationState<TResult, TState>