SimplePollerLike interface

Paket:

@azure/arm-elasticsan

Ein einfacher Poller, der zum Abrufen eines vorgangs mit langer Ausführung verwendet werden kann.

Methoden

getOperationState()	Gibt den Zustand der Operation zurück.
getResult()	Gibt den Ergebniswert der Operation zurück, unabhängig vom Zustand des Pollers. Sie kann je nach Implementierung undefinierte oder unvollständige Form des endgültigen TResult-Werts zurückgeben.
isDone()	Es gibt Wahrheit aus, wenn der Poller die Umfrage abgeschlossen hat.
isStopped()	Gibt wahr zurück, wenn der Poller gestoppt wird.
onProgress((state: TState) => void)	Ruft den bereitgestellten Callback nach Abschluss jedes Polings auf und sendet den aktuellen Zustand der Operation des Pollers. Es gibt eine Methode zurück, mit der man keine Updates mehr für die jeweilige Rückruffunktion erhalten kann.
poll({ abortSignal?: AbortSignalLike })	Gibt ein Versprechen zurück, das gelöst wird, sobald eine einzelne Abfrageanfrage abgeschlossen ist. Dies geschieht, indem die Aktualisierungsmethode der Poller-Operation aufgerufen wird.
pollUntilDone({ abortSignal?: AbortSignalLike })	Gibt ein Versprechen zurück, das aufgelöst wird, sobald die zugrunde liegende Operation abgeschlossen ist.
serialize()	Gibt ein Versprechen zurück, das für eine serialisierte Version der Operation des Pollers verwendet werden könnte, indem die Serialisierungsmethode der Operation aufgerufen wird.
stopPolling()	Das verhindert, dass der Poller weiter umfragt. Bitte beachten Sie, dass dies nur die Client-seitige Abfrage stoppt
submitted()	Warte, bis der Poller eingereicht wird.
toString()	Gibt eine String-Darstellung der Operation des Pollers zurück. Ähnlich wie Serializieren, aber mit einem String zurück.

Details zur Methode

getOperationState()

Gibt den Zustand der Operation zurück.

function getOperationState(): TState

Gibt zurück

TState

getResult()

Gibt den Ergebniswert der Operation zurück, unabhängig vom Zustand des Pollers. Sie kann je nach Implementierung undefinierte oder unvollständige Form des endgültigen TResult-Werts zurückgeben.

function getResult(): undefined | TResult

Gibt zurück

undefined | TResult

isDone()

Es gibt Wahrheit aus, wenn der Poller die Umfrage abgeschlossen hat.

function isDone(): boolean

Gibt zurück

boolean

isStopped()

Warnung

Diese API ist nun veraltet.

Use abortSignal status to track this instead.

Gibt wahr zurück, wenn der Poller gestoppt wird.

function isStopped(): boolean

Gibt zurück

boolean

onProgress((state: TState) => void)

Ruft den bereitgestellten Callback nach Abschluss jedes Polings auf und sendet den aktuellen Zustand der Operation des Pollers.

Es gibt eine Methode zurück, mit der man keine Updates mehr für die jeweilige Rückruffunktion erhalten kann.

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

Parameter

callback

(state: TState) => void

Gibt zurück

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Gibt ein Versprechen zurück, das gelöst wird, sobald eine einzelne Abfrageanfrage abgeschlossen ist. Dies geschieht, indem die Aktualisierungsmethode der Poller-Operation aufgerufen wird.

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

Parameter

options

{ abortSignal?: AbortSignalLike }

Gibt zurück

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

Gibt ein Versprechen zurück, das aufgelöst wird, sobald die zugrunde liegende Operation abgeschlossen ist.

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

Parameter

pollOptions

{ abortSignal?: AbortSignalLike }

Gibt zurück

Promise<TResult>

serialize()

Gibt ein Versprechen zurück, das für eine serialisierte Version der Operation des Pollers verwendet werden könnte, indem die Serialisierungsmethode der Operation aufgerufen wird.

function serialize(): Promise<string>

Gibt zurück

Promise<string>

stopPolling()

Warnung

Diese API ist nun veraltet.

Use abortSignal to stop polling instead.

Das verhindert, dass der Poller weiter umfragt. Bitte beachten Sie, dass dies nur die Client-seitige Abfrage stoppt

function stopPolling()

submitted()

Warte, bis der Poller eingereicht wird.

function submitted(): Promise<void>

Gibt zurück

Promise<void>

toString()

Warnung

Diese API ist nun veraltet.

Use serialize() instead.

Gibt eine String-Darstellung der Operation des Pollers zurück. Ähnlich wie Serializieren, aber mit einem String zurück.

function toString(): string

Gibt zurück

string