LROPoller Classe

  • Riferimento

Poller per operazioni a esecuzione prolungata.

Ereditarietà
Generic
LROPoller

Costruttore

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

Parametri

Nome Descrizione
client
Necessario
PipelineClient

Client del servizio pipeline
initial_response
Necessario
PipelineResponse

Risposta di chiamata iniziale
deserialization_callback
Necessario
callable oppure <xref:msrest.serialization.Model>

Callback che accetta una risposta e restituisce un oggetto deserializzato. Se viene specificata una sottoclasse del modello, questa operazione passa "deserialize" come callback.
polling_method
Necessario
PollingMethod

Strategia di polling da adottare

Metodi

add_done_callback

Aggiungere la funzione di callback da eseguire dopo il completamento dell'operazione a esecuzione prolungata, indipendentemente dallo stato dell'operazione.
continuation_token

Restituire un token di continuazione che consente di riavviare il poller in un secondo momento.
done

Controllare lo stato dell'operazione a esecuzione prolungata.
from_continuation_token
polling_method

Restituire il metodo di polling associato a questo poller.
remove_done_callback

Rimuovere un callback dall'operazione a esecuzione prolungata.
result

Restituisce il risultato dell'operazione a esecuzione prolungata o il risultato disponibile dopo il timeout specificato.
status

Restituisce la stringa di stato corrente.
wait

Attendere l'operazione a esecuzione prolungata per un periodo di tempo specificato. È possibile verificare se questa chiamata è terminata con il timeout con il metodo "done()".

add_done_callback

Aggiungere la funzione di callback da eseguire dopo il completamento dell'operazione a esecuzione prolungata, indipendentemente dallo stato dell'operazione.

add_done_callback(func: Callable) -> None

Parametri

Nome Descrizione
func
Necessario
callable

Funzione di callback che accetta almeno un argomento, un oggetto LongRunningOperation completato.

continuation_token

Restituire un token di continuazione che consente di riavviare il poller in un secondo momento.

continuation_token() -> str

Restituisce

Tipo Descrizione
str

Token di continuazione opaco

done

Controllare lo stato dell'operazione a esecuzione prolungata.

done() -> bool

Restituisce

Tipo Descrizione
bool

'True' se il processo è stato completato, altrimenti 'False'.

from_continuation_token 

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

Parametri

Nome Descrizione
polling_method
Necessario
continuation_token
Necessario

polling_method

Restituire il metodo di polling associato a questo poller.

polling_method() -> PollingMethod[PollingReturnType_co]

Restituisce

Tipo Descrizione
PollingMethod

Metodo di polling

remove_done_callback

Rimuovere un callback dall'operazione a esecuzione prolungata.

remove_done_callback(func: Callable) -> None

Parametri

Nome Descrizione
func
Necessario
callable

Funzione da rimuovere dai callback.

Eccezioni

Tipo Descrizione
ValueError

se l'operazione a esecuzione prolungata è già stata completata.

result

Restituisce il risultato dell'operazione a esecuzione prolungata o il risultato disponibile dopo il timeout specificato.

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

Parametri

Nome Descrizione
timeout
float

Periodo di tempo di attesa prima di tornare al controllo.

valore predefinito: None

Restituisce

Tipo Descrizione
any,
None

Risorsa deserializzata dell'operazione a esecuzione prolungata, se disponibile.

Eccezioni

Tipo Descrizione
HttpResponseError

Problema del server con la query.

status

Restituisce la stringa di stato corrente.

status() -> str

Restituisce

Tipo Descrizione
str

Stringa di stato corrente

wait

Attendere l'operazione a esecuzione prolungata per un periodo di tempo specificato. È possibile verificare se questa chiamata è terminata con il timeout con il metodo "done()".

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

Parametri

Nome Descrizione
timeout
Necessario
float

Periodo di tempo per attendere il completamento dell'operazione a esecuzione prolungata (in secondi).

Eccezioni

Tipo Descrizione
HttpResponseError

Problema del server con la query.