@azure/core-lro package

Modul LRO, třída, která provádí dotazování.

Třída, která představuje definici programu, který se dotazuje prostřednictvím po sobě jdoucích požadavků, dokud nedosáhne stavu dokončení.

Poller lze spustit ručně dotazováním požadavku podle požadavku opakovaným voláním poll() metody, dokud se jeho operace nedokončila. Poskytuje také způsob, jak čekat na dokončení operace voláním pollUntilDone() a čekáním na dokončení operace. Cyklické dotazování může také požádat o zrušení probíhajícího procesu, kterému se poskytuje základní dlouhotrvající operace.

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 je definován dvěma typy: typem představujícím stav poller, který musí obsahovat základní sadu vlastností z PollOperationState<TResult>a návratový typ definovaný nástrojem TResult, což může být cokoli.

Třída Poller implementuje PollerLike rozhraní, které umožňuje poller implementace, aby nemuseli exportovat třídu Poller přímo, a místo toho exportovat pouze již instance poller s typem 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();

Poller může být vytvořen prostřednictvím jeho konstruktoru a pak může být dotazován, dokud se nedokončí. V libovolném okamžiku lze stav poller získat bez zpoždění pomocí metody getOperationState. V libovolném okamžiku je možné bez prodlení požádat o zprostředkující formy typu výsledku. Jakmile se základní operace označí jako dokončená, poller se zastaví a vrátí se konečná hodnota.

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();

Po zrušení operace bude poller odmítnut s instancí PollerCancelledError.

Při ručním zastavení poller metodou stopPolling bude poller odmítnut s instancí PollerStoppedError.

Možnosti pro createPoller.

Popis dlouhotrvající operace

Možnosti pro LRO poller.

Typ odpovědi LRO.

Zatímco poller funguje jako místní řídicí mechanismus pro spuštění aktivace a čekání na dlouhotrvající operaci, OperationState dokumentuje stav vzdálené dlouhotrvající operace. Po každém hlasování se aktualizuje.

PollOperation je rozhraní, které definuje, jak aktualizovat místní odkaz na stav vzdálené dlouhotrvající operace, stejně jako jak požádat o zrušení stejné operace.

Má také metodu serializace operace, aby ji bylo možné kdykoli uložit a obnovit.

PollOperationState obsahuje seznam nejmenší sady vlastností potřebných k definování jakékoli dlouhotrvající operace poller.

Zatímco Třída Poller funguje jako místní řídicí mechanismus pro spuštění aktivace, čekání na a potenciálně zrušení dlouhotrvající operace PollOperationState dokumentuje stav vzdálené dlouhotrvající operace.

Měl by se aktualizovat alespoň při spuštění operace, po jejím dokončení a při jejím zrušení. Implementace ale můžou mít libovolný počet vlastností, které je možné aktualizovat z jiných důvodů.

Abstraktní reprezentace polleru, která má zpřístupnit jenom minimální rozhraní API, se kterým uživatel potřebuje pracovat.

Jednoduchý typ nezpracované odpovědi.

Jednoduché rozhraní poller.

CancelOnProgress se používá jako návratová hodnota pollerovy metody onProgress. Když uživatel vyvolá onProgress, musí předat funkci, která se bude volat jako zpětné volání s novými daty přijatými při každé aktualizaci operace dotazování. onProgress vrátí funkci, která zabrání jakékoli další aktualizaci, aby se dostala k původnímu zpětnému volání.

Potenciální umístění výsledku LRO, pokud je určeno rozšířením LRO ve swaggeru.

Sada možných stavů, ve které se operace může v daném okamžiku nacházet.

PollProgressCallback je typ funkcí zpětného volání odesílaných do onProgress. Tyto funkce obdrží TState, který je definován vaší implementací třídy Poller.

Vytvoří poller, který lze použít k dotazování dlouhotrvající operace.