LROPoller Klasa

Poller do długotrwałych operacji.

Dziedziczenie

Generic

LROPoller

Konstruktor

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

Parametry

Nazwa	Opis
client Wymagane	PipelineClient Klient usługi potoku
initial_response Wymagane	PipelineResponse Początkowa odpowiedź wywołania
deserialization_callback Wymagane	callable lub <xref:msrest.serialization.Model> Wywołanie zwrotne, które przyjmuje odpowiedź i zwraca obiekt deserializowany. Jeśli zostanie podana podklasa modelu, przekazuje to polecenie "deserialize" jako wywołanie zwrotne.
polling_method Wymagane	PollingMethod Strategia sondowania do przyjęcia

Metody

add_done_callback	Dodaj funkcję wywołania zwrotnego, która ma być uruchamiana po zakończeniu długotrwałej operacji — niezależnie od stanu operacji.
continuation_token	Zwróć token kontynuacji, który umożliwia późniejsze ponowne uruchomienie elementu poller.
done	Sprawdź stan długotrwałej operacji.
from_continuation_token
polling_method	Zwróć metodę sondowania skojarzona z tym elementem poller.
remove_done_callback	Usuń wywołanie zwrotne z długotrwałej operacji.
result	Zwróć wynik długotrwałej operacji lub wynik dostępny po określonym przekroczeniu limitu czasu.
status	Zwraca bieżący ciąg stanu.
wait	Zaczekaj na długotrwałą operację przez określony czas. Możesz sprawdzić, czy to wywołanie zostało zakończone przekroczeniem limitu czasu za pomocą metody "done()".

add_done_callback

Dodaj funkcję wywołania zwrotnego, która ma być uruchamiana po zakończeniu długotrwałej operacji — niezależnie od stanu operacji.

add_done_callback(func: Callable) -> None

Parametry

Nazwa	Opis
func Wymagane	callable Funkcja wywołania zwrotnego, która przyjmuje co najmniej jeden argument, ukończoną funkcję LongRunningOperation.

continuation_token

Zwróć token kontynuacji, który umożliwia późniejsze ponowne uruchomienie elementu poller.

continuation_token() -> str

Zwraca

Typ	Opis
str	Nieprzezroczysty token kontynuacji

done

Sprawdź stan długotrwałej operacji.

done() -> bool

Zwraca

Typ	Opis
bool	"True", jeśli proces został ukończony, w przeciwnym razie "Fałsz".

from_continuation_token

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

Parametry

Nazwa	Opis
polling_method Wymagane
continuation_token Wymagane

polling_method

Zwróć metodę sondowania skojarzona z tym elementem poller.

polling_method() -> PollingMethod[PollingReturnType_co]

Zwraca

Typ	Opis
PollingMethod	Metoda sondowania

remove_done_callback

Usuń wywołanie zwrotne z długotrwałej operacji.

remove_done_callback(func: Callable) -> None

Parametry

Nazwa	Opis
func Wymagane	callable Funkcja, która ma zostać usunięta z wywołań zwrotnych.

Wyjątki

Typ	Opis
ValueError	jeśli długotrwała operacja została już ukończona.

result

Zwróć wynik długotrwałej operacji lub wynik dostępny po określonym przekroczeniu limitu czasu.

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

Parametry

Nazwa	Opis
timeout	float Okres oczekiwania przed powrotem kontroli. wartość domyślna: None

Zwraca

Typ	Opis
any, None	Deserializowany zasób długotrwałej operacji, jeśli jest dostępny.

Wyjątki

Typ	Opis
HttpResponseError	Problem z serwerem z zapytaniem.

status

Zwraca bieżący ciąg stanu.

status() -> str

Zwraca

Typ	Opis
str	Bieżący ciąg stanu

wait

Zaczekaj na długotrwałą operację przez określony czas. Możesz sprawdzić, czy to wywołanie zostało zakończone przekroczeniem limitu czasu za pomocą metody "done()".

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

Parametry

Nazwa	Opis
timeout Wymagane	float Okres oczekiwania na ukończenie długiej operacji (w sekundach).

Wyjątki

Typ	Opis
HttpResponseError	Problem z serwerem z zapytaniem.