PollOperation interface

Paket:

@azure/core-lro

PollOperation ist eine Schnittstelle, die definiert, wie der lokale Verweis auf den Zustand des Remotevorgangs mit langer Ausführungsdauer aktualisiert wird, ebenso wie das Anfordern des Abbruchs desselben Vorgangs.

Außerdem verfügt sie über eine Methode zum Serialisieren des Vorgangs, sodass er jederzeit gespeichert und fortgesetzt werden kann.

Eigenschaften

state

Der Zustand des Vorgangs. Es wird verwendet, um die grundlegenden Eigenschaften von PollOperationState sowie alle benutzerdefinierten Eigenschaften zu speichern, die die Implementierung möglicherweise erfordert.

Methoden

cancel({ abortSignal?: AbortSignalLike })	Versucht, den zugrunde liegenden Vorgang abzubrechen. Es empfängt nur optional ein Objekt mit einer abortSignal-Eigenschaft aus @azure/abort-controller's AbortSignalLike. Es gibt eine Zusage zurück, die mit einer aktualisierten Version des Abfragevorgangs aufgelöst werden sollte.
toString()	Serialisiert den Vorgang. Nützlich, wenn Sie einen Poller erstellen möchten, der einen vorhandenen Vorgang überwacht.
update({ abortSignal?: AbortSignalLike, fireProgress?: (state: TState) => void })	Definiert, wie der Remotedienst Updates für den Status des vorgangs mit langer Ausführungsdauer anzufordern. Optional empfängt es ein Objekt mit einer abortSignal-Eigenschaft aus @azure/abort-controller's AbortSignalLike. Optional erhält auch eine "fireProgress"-Funktion, die bei Aufruf für das Auslösen der onProgress-Rückrufe des Pollers verantwortlich ist.

Details zur Eigenschaft

state

Der Zustand des Vorgangs. Es wird verwendet, um die grundlegenden Eigenschaften von PollOperationState sowie alle benutzerdefinierten Eigenschaften zu speichern, die die Implementierung möglicherweise erfordert.

state: TState

Eigenschaftswert

TState

Details zur Methode

cancel({ abortSignal?: AbortSignalLike })

Warnung

Diese API ist nun veraltet.

cancel has been deprecated because it was not implemented.

Versucht, den zugrunde liegenden Vorgang abzubrechen.

Es empfängt nur optional ein Objekt mit einer abortSignal-Eigenschaft aus @azure/abort-controller's AbortSignalLike.

Es gibt eine Zusage zurück, die mit einer aktualisierten Version des Abfragevorgangs aufgelöst werden sollte.

function cancel(options?: { abortSignal?: AbortSignalLike }): Promise<PollOperation<TState, TResult>>

Parameter

options

{ abortSignal?: AbortSignalLike }

Optionale Eigenschaften, die an die Updatemethode des Vorgangs übergeben werden.

Gibt zurück

Promise<PollOperation<TState, TResult>>

toString()

Serialisiert den Vorgang. Nützlich, wenn Sie einen Poller erstellen möchten, der einen vorhandenen Vorgang überwacht.

function toString(): string

Gibt zurück

string

update({ abortSignal?: AbortSignalLike, fireProgress?: (state: TState) => void })

Definiert, wie der Remotedienst Updates für den Status des vorgangs mit langer Ausführungsdauer anzufordern.

Optional empfängt es ein Objekt mit einer abortSignal-Eigenschaft aus @azure/abort-controller's AbortSignalLike. Optional erhält auch eine "fireProgress"-Funktion, die bei Aufruf für das Auslösen der onProgress-Rückrufe des Pollers verantwortlich ist.

function update(options?: { abortSignal?: AbortSignalLike, fireProgress?: (state: TState) => void }): Promise<PollOperation<TState, TResult>>

Parameter

options

{ abortSignal?: AbortSignalLike, fireProgress?: (state: TState) => void }

Optionale Eigenschaften, die an die Updatemethode des Vorgangs übergeben werden.

Gibt zurück

Promise<PollOperation<TState, TResult>>