LROPoller Class

  • Reference

Poller for long running operations.

Inheritance
Generic
LROPoller

Constructor

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

Parameters

Name Description
client
Required
PipelineClient

A pipeline service client
initial_response
Required
PipelineResponse

The initial call response
deserialization_callback
Required
callable or <xref:msrest.serialization.Model>

A callback that takes a Response and return a deserialized object. If a subclass of Model is given, this passes "deserialize" as callback.
polling_method
Required
PollingMethod

The polling strategy to adopt

Methods

add_done_callback

Add callback function to be run once the long running operation has completed - regardless of the status of the operation.
continuation_token

Return a continuation token that allows to restart the poller later.
done

Check status of the long running operation.
from_continuation_token
polling_method

Return the polling method associated to this poller.
remove_done_callback

Remove a callback from the long running operation.
result

Return the result of the long running operation, or the result available after the specified timeout.
status

Returns the current status string.
wait

Wait on the long running operation for a specified length of time. You can check if this call as ended with timeout with the "done()" method.

add_done_callback

Add callback function to be run once the long running operation has completed - regardless of the status of the operation.

add_done_callback(func: Callable) -> None

Parameters

Name Description
func
Required
callable

Callback function that takes at least one argument, a completed LongRunningOperation.

continuation_token

Return a continuation token that allows to restart the poller later.

continuation_token() -> str

Returns

Type Description
str

An opaque continuation token

done

Check status of the long running operation.

done() -> bool

Returns

Type Description
bool

'True' if the process has completed, else 'False'.

from_continuation_token 

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

Parameters

Name Description
polling_method
Required
continuation_token
Required

polling_method

Return the polling method associated to this poller.

polling_method() -> PollingMethod[PollingReturnType_co]

Returns

Type Description
PollingMethod

The polling method

remove_done_callback

Remove a callback from the long running operation.

remove_done_callback(func: Callable) -> None

Parameters

Name Description
func
Required
callable

The function to be removed from the callbacks.

Exceptions

Type Description
ValueError

if the long running operation has already completed.

result

Return the result of the long running operation, or the result available after the specified timeout.

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

Parameters

Name Description
timeout
float

Period of time to wait before getting back control.

Default value: None

Returns

Type Description
any,
None

The deserialized resource of the long running operation, if one is available.

Exceptions

Type Description
HttpResponseError

Server problem with the query.

status

Returns the current status string.

status() -> str

Returns

Type Description
str

The current status string

wait

Wait on the long running operation for a specified length of time. You can check if this call as ended with timeout with the "done()" method.

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

Parameters

Name Description
timeout
Required
float

Period of time to wait for the long running operation to complete (in seconds).

Exceptions

Type Description
HttpResponseError

Server problem with the query.