SimplePollerLike interface

Pakket:

@azure/arm-elasticsan

Een eenvoudige poller die kan worden gebruikt om een langdurige bewerking te peilen.

Methoden

getOperationState()	Geeft de staat van de operatie terug.
getResult()	Geeft de resultaatwaarde van de bewerking terug, ongeacht de toestand van de poller. Het kan ongedefinieerde of onvolledige vorm van de uiteindelijke TResult-waarde teruggeven, afhankelijk van de implementatie.
isDone()	Geeft een uitslag als de peiler klaar is met peilen.
isStopped()	Geeft waar terug als de poller wordt gestopt.
onProgress((state: TState) => void)	Roept de meegeleverde callback aan nadat elke polling is voltooid, waarbij de huidige status van de poller-operatie wordt verzonden. Het geeft een methode terug die kan worden gebruikt om te voorkomen dat updates worden ontvangen over de betreffende callback-functie.
poll({ abortSignal?: AbortSignalLike })	Geeft een belofte terug die wordt opgelost zodra een enkel pollingverzoek is afgerond. Dit gebeurt door de update-methode van de Poller-operatie aan te roepen.
pollUntilDone({ abortSignal?: AbortSignalLike })	Geeft een belofte terug die wordt opgelost zodra de onderliggende bewerking is voltooid.
serialize()	Geeft een belofte terug die gebruikt kan worden voor een geserialiseerde versie van de poller-operatie door de serialisatiemethode van de operatie aan te roepen.
stopPolling()	Voorkomt dat de peiler blijft peilen. Let op: dit stopt alleen de polling aan clientzijde
submitted()	Wacht tot de poller wordt ingediend.
toString()	Geeft een stringrepresentatie van de operatie van de poller terug. Vergelijkbaar met serializen, maar dan met een string terug.

Methodedetails

getOperationState()

Geeft de staat van de operatie terug.

function getOperationState(): TState

Retouren

TState

getResult()

Geeft de resultaatwaarde van de bewerking terug, ongeacht de toestand van de poller. Het kan ongedefinieerde of onvolledige vorm van de uiteindelijke TResult-waarde teruggeven, afhankelijk van de implementatie.

function getResult(): undefined | TResult

Retouren

undefined | TResult

isDone()

Geeft een uitslag als de peiler klaar is met peilen.

function isDone(): boolean

Retouren

boolean

isStopped()

Waarschuwing

Deze API is nu afgeschaft.

Use abortSignal status to track this instead.

Geeft waar terug als de poller wordt gestopt.

function isStopped(): boolean

Retouren

boolean

onProgress((state: TState) => void)

Roept de meegeleverde callback aan nadat elke polling is voltooid, waarbij de huidige status van de poller-operatie wordt verzonden.

Het geeft een methode terug die kan worden gebruikt om te voorkomen dat updates worden ontvangen over de betreffende callback-functie.

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

Parameters

callback

(state: TState) => void

Retouren

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Geeft een belofte terug die wordt opgelost zodra een enkel pollingverzoek is afgerond. Dit gebeurt door de update-methode van de Poller-operatie aan te roepen.

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

Parameters

options

{ abortSignal?: AbortSignalLike }

Retouren

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Geeft een belofte terug die wordt opgelost zodra de onderliggende bewerking is voltooid.

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

Parameters

pollOptions

{ abortSignal?: AbortSignalLike }

Retouren

Promise<TResult>

serialize()

Geeft een belofte terug die gebruikt kan worden voor een geserialiseerde versie van de poller-operatie door de serialisatiemethode van de operatie aan te roepen.

function serialize(): Promise<string>

Retouren

Promise<string>

stopPolling()

Waarschuwing

Deze API is nu afgeschaft.

Use abortSignal to stop polling instead.

Voorkomt dat de peiler blijft peilen. Let op: dit stopt alleen de polling aan clientzijde

function stopPolling()

submitted()

Wacht tot de poller wordt ingediend.

function submitted(): Promise<void>

Retouren

Promise<void>

toString()

Waarschuwing

Deze API is nu afgeschaft.

Use serialize() instead.

Geeft een stringrepresentatie van de operatie van de poller terug. Vergelijkbaar met serializen, maar dan met een string terug.

function toString(): string

Retouren

string