LROPoller Clase

  • Referencia

Sondeo para operaciones de larga duración.

Herencia
Generic
LROPoller

Constructor

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

Parámetros

Nombre Description
client
Requerido
PipelineClient

Un cliente de servicio de canalización
initial_response
Requerido
PipelineResponse

Respuesta de llamada inicial
deserialization_callback
Requerido
callable o <xref:msrest.serialization.Model>

Devolución de llamada que toma una respuesta y devuelve un objeto deserializado. Si se da una subclase de Model, se pasa "deserializar" como devolución de llamada.
polling_method
Requerido
PollingMethod

La estrategia de sondeo que se va a adoptar

Métodos

add_done_callback

Agregue la función de devolución de llamada que se va a ejecutar una vez completada la operación de larga duración, independientemente del estado de la operación.
continuation_token

Devuelve un token de continuación que permite reiniciar el sondeo más adelante.
done

Compruebe el estado de la operación de larga duración.
from_continuation_token
polling_method

Devuelve el método de sondeo asociado a este sondeo.
remove_done_callback

Quite una devolución de llamada de la operación de larga duración.
result

Devuelve el resultado de la operación de larga duración o el resultado disponible después del tiempo de espera especificado.
status

Devuelve la cadena de estado actual.
wait

Espere en la operación de larga duración durante un período de tiempo especificado. Puede comprobar si esta llamada finalizó con el tiempo de espera con el método "done()".

add_done_callback

Agregue la función de devolución de llamada que se va a ejecutar una vez completada la operación de larga duración, independientemente del estado de la operación.

add_done_callback(func: Callable) -> None

Parámetros

Nombre Description
func
Requerido
callable

Función de devolución de llamada que toma al menos un argumento, un LongRunningOperation completado.

continuation_token

Devuelve un token de continuación que permite reiniciar el sondeo más adelante.

continuation_token() -> str

Devoluciones

Tipo Description
str

Un token de continuación opaco

done

Compruebe el estado de la operación de larga duración.

done() -> bool

Devoluciones

Tipo Description
bool

'True' si el proceso se ha completado, de lo contrario ,'False'.

from_continuation_token 

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

Parámetros

Nombre Description
polling_method
Requerido
continuation_token
Requerido

polling_method

Devuelve el método de sondeo asociado a este sondeo.

polling_method() -> PollingMethod[PollingReturnType_co]

Devoluciones

Tipo Description
PollingMethod

Método de sondeo

remove_done_callback

Quite una devolución de llamada de la operación de larga duración.

remove_done_callback(func: Callable) -> None

Parámetros

Nombre Description
func
Requerido
callable

Función que se va a quitar de las devoluciones de llamada.

Excepciones

Tipo Description
ValueError

si la operación de larga duración ya se ha completado.

result

Devuelve el resultado de la operación de larga duración o el resultado disponible después del tiempo de espera especificado.

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

Parámetros

Nombre Description
timeout
float

Período de tiempo que se debe esperar antes de recuperar el control.

valor predeterminado: None

Devoluciones

Tipo Description
any,
None

Recurso deserializado de la operación de larga duración, si hay uno disponible.

Excepciones

Tipo Description
HttpResponseError

Problema del servidor con la consulta.

status

Devuelve la cadena de estado actual.

status() -> str

Devoluciones

Tipo Description
str

Cadena de estado actual

wait

Espere en la operación de larga duración durante un período de tiempo especificado. Puede comprobar si esta llamada finalizó con el tiempo de espera con el método "done()".

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

Parámetros

Nombre Description
timeout
Requerido
float

Período de tiempo para esperar a que se complete la operación de larga duración (en segundos).

Excepciones

Tipo Description
HttpResponseError

Problema del servidor con la consulta.