SimplePollerLike interface

Csomag:

@azure-rest/arm-compute

Egy egyszerű beporzó, amely egy hosszú ideig futó művelet lekérdezésére használható.

Metódusok

getOperationState()	A művelet állapotát adja vissza.
getResult()	A művelet eredményértékét adja vissza a lekérdezés állapotától függetlenül. A végleges TResult érték nem definiált vagy hiányos formáját is visszaadhatja a megvalósítástól függően.
isDone()	Igaz értéket ad vissza, ha a lekérdezés befejeződött.
isStopped()	Igaz értéket ad vissza, ha a lekérdezés leáll.
onProgress((state: TState) => void)	Meghívja a megadott visszahívást az egyes lekérdezések befejezése után, és elküldi a lekérdezési művelet aktuális állapotát. Egy metódust ad vissza, amellyel a rendszer leállítja a frissítések fogadását az adott visszahívási függvényben.
poll({ abortSignal?: AbortSignalLike })	Egy ígéretet ad vissza, amely egyetlen lekérdezési kérelem befejeződése után feloldható. Ezt úgy teszi, hogy meghívja a Poller műveletének frissítési metódusát.
pollUntilDone({ abortSignal?: AbortSignalLike })	Az alapul szolgáló művelet befejezése után feloldható ígéretet ad vissza.
serialize()	Olyan ígéretet ad vissza, amely a lekérdezési művelet szerializált verziójához használható a művelet szerializálási metódusának meghívásával.
stopPolling()	Megakadályozza, hogy a lekérdezés folytatódjon. Vegye figyelembe, hogy ez csak az ügyféloldali lekérdezést állítja le
submitted()	Várja meg, amíg a beporzó el lesz küldve.
toString()	A lekérdezési művelet sztring-ábrázolását adja vissza. Hasonló a szerializáláshoz, de visszaad egy sztringet.

Metódus adatai

getOperationState()

A művelet állapotát adja vissza.

function getOperationState(): TState

Válaszok

TState

getResult()

A művelet eredményértékét adja vissza a lekérdezés állapotától függetlenül. A végleges TResult érték nem definiált vagy hiányos formáját is visszaadhatja a megvalósítástól függően.

function getResult(): undefined | TResult

Válaszok

undefined | TResult

isDone()

Igaz értéket ad vissza, ha a lekérdezés befejeződött.

function isDone(): boolean

Válaszok

boolean

isStopped()

Figyelmeztetés

Ez az API már elavult.

Use abortSignal status to track this instead.

Igaz értéket ad vissza, ha a lekérdezés leáll.

function isStopped(): boolean

Válaszok

boolean

onProgress((state: TState) => void)

Meghívja a megadott visszahívást az egyes lekérdezések befejezése után, és elküldi a lekérdezési művelet aktuális állapotát.

Egy metódust ad vissza, amellyel a rendszer leállítja a frissítések fogadását az adott visszahívási függvényben.

function onProgress(callback: (state: TState) => void): CancelOnProgress

Paraméterek

callback

(state: TState) => void

Válaszok

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Egy ígéretet ad vissza, amely egyetlen lekérdezési kérelem befejeződése után feloldható. Ezt úgy teszi, hogy meghívja a Poller műveletének frissítési metódusát.

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>

Paraméterek

options

{ abortSignal?: AbortSignalLike }

Válaszok

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Az alapul szolgáló művelet befejezése után feloldható ígéretet ad vissza.

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

Paraméterek

pollOptions

{ abortSignal?: AbortSignalLike }

Válaszok

Promise<TResult>

serialize()

Olyan ígéretet ad vissza, amely a lekérdezési művelet szerializált verziójához használható a művelet szerializálási metódusának meghívásával.

function serialize(): Promise<string>

Válaszok

Promise<string>

stopPolling()

Figyelmeztetés

Ez az API már elavult.

Use abortSignal to stop polling instead.

Megakadályozza, hogy a lekérdezés folytatódjon. Vegye figyelembe, hogy ez csak az ügyféloldali lekérdezést állítja le

function stopPolling()

submitted()

Várja meg, amíg a beporzó el lesz küldve.

function submitted(): Promise<void>

Válaszok

Promise<void>

toString()

Figyelmeztetés

Ez az API már elavult.

Use serialize() instead.

A lekérdezési művelet sztring-ábrázolását adja vissza. Hasonló a szerializáláshoz, de visszaad egy sztringet.

function toString(): string

Válaszok

string