@azure/core-lro package

ポーリングを実行するクラスである LRO エンジン。

完了状態になるまで連続する要求をポーリングするプログラムの定義を表す クラス。

ポーリングは、操作が完了するまでメソッドを繰り返し呼び出 poll() すことによって要求をポーリングすることによって、手動で実行できます。 また、操作が完了するまで を呼び出 pollUntilDone() して待機することで、操作が完了するまで待機する方法も提供されます。 ポーリング者は、基になる実行時間の長い操作を提供している進行中のプロセスの取り消しを要求することもできます。

const poller = new MyPoller();

// Polling just once:
await poller.poll();

// We can try to cancel the request here, by calling:
//
//     await poller.cancelOperation();
//

// Getting the final result:
const result = await poller.pollUntilDone();

Poller は、ポーリングの状態を表す型の 2 つの型で定義されます。これには、 の PollOperationState<TResult>プロパティの基本セットと、 で定義された TResult戻り値の型を含める必要があります。これは何でもかまいません。

Poller クラスは インターフェイスを PollerLike 実装します。これにより、poller の実装で Poller のクラスを直接エクスポートする必要がなくなります。代わりに、PollerLike 型で既にインスタンス化されたポーリングャーのみをエクスポートできます。

class Client {
  public async makePoller: PollerLike<MyOperationState, MyResult> {
    const poller = new MyPoller({});
    // It might be preferred to return the poller after the first request is made,
    // so that some information can be obtained right away.
    await poller.poll();
    return poller;
  }
}

const poller: PollerLike<MyOperationState, MyResult> = myClient.makePoller();

ポーリングはコンストラクターを使用して作成できます。その後、完了するまでポーリングできます。 ポーリングの状態は、いつでも getOperationState メソッドを使用して遅延なく取得できます。 結果の種類の中間フォームは、いつでも遅延なく要求できます。 基になる操作が完了としてマークされると、ポーリングが停止し、最終的な値が返されます。

const poller = myClient.makePoller();
const state: MyOperationState = poller.getOperationState();

// The intermediate result can be obtained at any time.
const result: MyResult | undefined = poller.getResult();

// The final result can only be obtained after the poller finishes.
const result: MyResult = await poller.pollUntilDone();

操作が取り消されると、PollerCancelledError のインスタンスを使用してポーリングが拒否されます。

メソッドを使用して stopPolling ポーリングを手動で停止すると、PollerStoppedError のインスタンスを使用してポーリングが拒否されます。

の createPollerオプション。

実行時間の長い操作の説明。

LRO ポーラーのオプション。

LRO の応答の型。

ポーリングは、実行時間の長い操作のトリガーと待機を開始するローカル制御メカニズムとして機能しますが、OperationState はリモートの実行時間の長い操作の状態を文書化します。 各ポーリングの後に更新されます。

PollOperation は、リモート実行時間の長い操作の状態のローカル参照を更新する方法と、同じ操作のキャンセルを要求する方法を定義するインターフェイスです。

また、操作をいつでも格納および再開できるように、操作をシリアル化するメソッドもあります。

PollOperationState には、実行時間の長い操作ポーラーを定義するために必要な最小のプロパティ セットの一覧が含まれています。

Poller クラスは、実行時間の長い操作のトリガー、待機、および取り消しを開始するローカル制御メカニズムとして機能しますが、PollOperationState はリモート実行時間の長い操作の状態を文書化します。

少なくとも操作が開始されたとき、操作が完了したとき、取り消されたときは更新する必要があります。 ただし、実装には、他の理由で更新できる他の数のプロパティを含めることができます。

ユーザーが操作する必要がある最小限の API のみを公開することを目的とした、ポーリングャーの抽象的な表現。

生の応答の単純な型。

単純なポーリング インターフェイス。

CancelOnProgress は、Poller の onProgress メソッドの戻り値として使用されます。 ユーザーが onProgress を呼び出すとき、ポーリング操作が更新されるたびに受信した新しいデータを使用してコールバックとして呼び出される関数を渡す必要があります。 onProgress は、それ以上の更新が元のコールバックに到達するのを防ぐ関数を返します。

Swagger の LRO 拡張機能で指定されている場合の、LRO の結果の潜在的な場所。

指定した時点で操作を実行できる一連の状態。

PollProgressCallback は、onProgress に送信されるコールバック関数の型です。 これらの関数は、Poller クラスの実装によって定義された TState を受け取ります。

実行時間の長い操作をポーリングするために使用できるポーリングャーを作成します。