LROPoller Klasse

  • Referenz

Poller für Vorgänge mit langer Ausführungsdauer.

Vererbung
Generic
LROPoller

Konstruktor

LROPoller(client: Any, initial_response: Any, deserialization_callback: Callable[[Any], PollingReturnType_co], polling_method: PollingMethod[PollingReturnType_co])

Parameter

Name Beschreibung
client
Erforderlich
PipelineClient

Ein Pipelinedienstclient
initial_response
Erforderlich
PipelineResponse

Die anfängliche Anrufantwort
deserialization_callback
Erforderlich
callable oder <xref:msrest.serialization.Model>

Ein Rückruf, der eine Antwort akzeptiert und ein deserialisiertes Objekt zurückgibt. Wenn eine Unterklasse von Model angegeben wird, übergibt dies "deserialize" als Rückruf.
polling_method
Erforderlich
PollingMethod

Die zu übernehmende Umfragestrategie

Methoden

add_done_callback

Fügen Sie die Rückruffunktion hinzu, die ausgeführt werden soll, sobald der vorgang mit langer Ausführungsdauer abgeschlossen ist – unabhängig von der status des Vorgangs.
continuation_token

Gibt ein Fortsetzungstoken zurück, mit dem der Poller später neu gestartet werden kann.
done

Überprüfen Sie status des vorgangs mit langer Ausführungsdauer.
from_continuation_token
polling_method

Gibt die diesem Poller zugeordnete Abfragemethode zurück.
remove_done_callback

Entfernen Sie einen Rückruf aus dem Vorgang mit langer Ausführungsdauer.
result

Gibt das Ergebnis des Vorgangs mit langer Ausführung oder das nach dem angegebenen Timeout verfügbare Ergebnis zurück.
status

Gibt die aktuelle status Zeichenfolge zurück.
wait

Warten Sie auf den Vorgang mit langer Ausführungsdauer für eine bestimmte Zeit. Sie können mit der Methode "done()" überprüfen, ob dieser Aufruf mit timeout beendet wurde.

add_done_callback

Fügen Sie die Rückruffunktion hinzu, die ausgeführt werden soll, sobald der vorgang mit langer Ausführungsdauer abgeschlossen ist – unabhängig von der status des Vorgangs.

add_done_callback(func: Callable) -> None

Parameter

Name Beschreibung
func
Erforderlich
callable

Rückruffunktion, die mindestens ein Argument akzeptiert, eine abgeschlossene LongRunningOperation.

continuation_token

Gibt ein Fortsetzungstoken zurück, mit dem der Poller später neu gestartet werden kann.

continuation_token() -> str

Gibt zurück

Typ Beschreibung
str

Ein undurchsichtiges Fortsetzungstoken

done

Überprüfen Sie status des vorgangs mit langer Ausführungsdauer.

done() -> bool

Gibt zurück

Typ Beschreibung
bool

"True", wenn der Prozess abgeschlossen wurde, andernfalls "False".

from_continuation_token 

from_continuation_token(polling_method: PollingMethod[PollingReturnType_co], continuation_token: str, **kwargs: Any) -> LROPoller[PollingReturnType_co]

Parameter

Name Beschreibung
polling_method
Erforderlich
continuation_token
Erforderlich

polling_method

Gibt die diesem Poller zugeordnete Abfragemethode zurück.

polling_method() -> PollingMethod[PollingReturnType_co]

Gibt zurück

Typ Beschreibung
PollingMethod

Die Abfragemethode

remove_done_callback

Entfernen Sie einen Rückruf aus dem Vorgang mit langer Ausführungsdauer.

remove_done_callback(func: Callable) -> None

Parameter

Name Beschreibung
func
Erforderlich
callable

Die Funktion, die aus den Rückrufen entfernt werden soll.

Ausnahmen

Typ Beschreibung
ValueError

, wenn der vorgang mit langer Ausführungsdauer bereits abgeschlossen wurde.

result

Gibt das Ergebnis des Vorgangs mit langer Ausführung oder das nach dem angegebenen Timeout verfügbare Ergebnis zurück.

result(timeout: float | None = None) -> PollingReturnType_co

Parameter

Name Beschreibung
timeout
float

Zeitraum zum Warten, bevor sie die Kontrolle zurückerhalten.

Standardwert: None

Gibt zurück

Typ Beschreibung
any,
None

Die deserialisierte Ressource des Vorgangs mit langer Ausführungsdauer, sofern verfügbar.

Ausnahmen

Typ Beschreibung
HttpResponseError

Serverproblem mit der Abfrage.

status

Gibt die aktuelle status Zeichenfolge zurück.

status() -> str

Gibt zurück

Typ Beschreibung
str

Die aktuelle status Zeichenfolge

wait

Warten Sie auf den Vorgang mit langer Ausführungsdauer für eine bestimmte Zeit. Sie können mit der Methode "done()" überprüfen, ob dieser Aufruf mit timeout beendet wurde.

wait(timeout: float | None = None) -> None

Parameter

Name Beschreibung
timeout
Erforderlich
float

Zeitraum zum Warten auf den Abschluss des vorgangs mit langer Ausführungsdauer (in Sekunden).

Ausnahmen

Typ Beschreibung
HttpResponseError

Serverproblem mit der Abfrage.