Dela via


TextAnalysisLROPoller Klass

Implementerar ett protokoll som returnerade pollerobjekt överensstämmer med.

Arv
typing_extensions.Protocol
TextAnalysisLROPoller

Konstruktor

TextAnalysisLROPoller(*args, **kwargs)

Metoder

add_done_callback

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

cancel

Avbryt åtgärden som för närvarande avsöks.

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.

remove_done_callback

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

result

Returnera resultatet av den långvariga åtgärden eller resultatet som är tillgängligt 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 avslutades med timeout med metoden "done()".

add_done_callback

Lägg till återanropsfunktion 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

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

cancel

Avbryt åtgärden som för närvarande avsöks.

cancel() -> None

Returer

Typ Description

Ingen

Undantag

Typ Description

När åtgärden redan har nått ett terminaltillstånd.

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

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

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

Funktionen som ska tas bort från återanropen.

Undantag

Typ Description

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

result

Returnera resultatet av den långvariga åtgärden eller resultatet som är tillgängligt efter den angivna tidsgränsen.

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

Parametrar

Name Description
timeout
standardvärde: None

Returer

Typ Description

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

Undantag

Typ Description

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 avslutades med timeout med metoden "done()".

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

Parametrar

Name Description
timeout

Tidsperiod för att vänta tills den tidskrävande åtgärden har slutförts (i sekunder).

standardvärde: None

Undantag

Typ Description

Serverproblem med frågan.

Attribut

details

Långvariga åtgärdsmetadata.

Returer

Typ Description

En mappning av information om den långvariga åtgärden.