LROPoller Klass

  • Referens

Poller för långvariga åtgärder.

Arv
Generic
LROPoller

Konstruktor

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

Parametrar

Name Description
client
Obligatorisk
PipelineClient

En pipelinetjänstklient
initial_response
Obligatorisk
PipelineResponse

Det första anropssvaret
deserialization_callback
Obligatorisk
callable eller <xref:msrest.serialization.Model>

Ett återanrop som tar ett svar och returnerar ett avserialiserat objekt. Om en underklass av Model anges skickas "deserialize" som motringning.
polling_method
Obligatorisk
PollingMethod

Avsökningsstrategin för att införa

Metoder

add_done_callback

Lägg till återanropsfunktionen som ska köras när den långvariga åtgärden har slutförts – oavsett status för åtgärden.
continuation_token

Returnera en fortsättningstoken som gör det möjligt att starta om pollern senare.
done

Kontrollera status för den långvariga åtgärden.
from_continuation_token
polling_method

Returnera avsökningsmetoden som är associerad med den här pollern.
remove_done_callback

Ta bort ett återanrop från den långvariga åtgärden.
result

Returnera resultatet av den långvariga åtgärden eller det tillgängliga resultatet efter den angivna tidsgränsen.
status

Returnerar den aktuella statussträngen.
wait

Vänta på den långvariga åtgärden under en angiven tidsperiod. Du kan kontrollera om det här anropet slutade med timeout med metoden "done()".

add_done_callback

Lägg till återanropsfunktionen som ska köras när den långvariga åtgärden har slutförts – oavsett status för åtgärden.

add_done_callback(func: Callable) -> None

Parametrar

Name Description
func
Obligatorisk
callable

Återanropsfunktion som tar minst ett argument, en slutförd LongRunningOperation.

continuation_token

Returnera en fortsättningstoken som gör det möjligt att starta om pollern senare.

continuation_token() -> str

Returer

Typ Description
str

En täckande fortsättningstoken

done

Kontrollera status för den långvariga åtgärden.

done() -> bool

Returer

Typ Description
bool

"Sant" om processen har slutförts, annars "False".

from_continuation_token 

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

Parametrar

Name Description
polling_method
Obligatorisk
continuation_token
Obligatorisk

polling_method

Returnera avsökningsmetoden som är associerad med den här pollern.

polling_method() -> PollingMethod[PollingReturnType_co]

Returer

Typ Description
PollingMethod

Avsökningsmetoden

remove_done_callback

Ta bort ett återanrop från den långvariga åtgärden.

remove_done_callback(func: Callable) -> None

Parametrar

Name Description
func
Obligatorisk
callable

Funktionen som ska tas bort från återanropen.

Undantag

Typ Description
ValueError

om den långvariga åtgärden redan har slutförts.

result

Returnera resultatet av den långvariga åtgärden eller det tillgängliga resultatet efter den angivna tidsgränsen.

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

Parametrar

Name Description
timeout
float

Väntetid innan du får tillbaka kontrollen.

standardvärde: None

Returer

Typ Description
any,
None

Den avserialiserade resursen för den långvariga åtgärden, om en är tillgänglig.

Undantag

Typ Description
HttpResponseError

Serverproblem med frågan.

status

Returnerar den aktuella statussträngen.

status() -> str

Returer

Typ Description
str

Den aktuella statussträngen

wait

Vänta på den långvariga åtgärden under en angiven tidsperiod. Du kan kontrollera om det här anropet slutade med timeout med metoden "done()".

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

Parametrar

Name Description
timeout
Obligatorisk
float

Tidsperiod att vänta tills den långvariga åtgärden har slutförts (i sekunder).

Undantag

Typ Description
HttpResponseError

Serverproblem med frågan.