Share via

AsyncLROPoller Class

  • Reference

Async poller for long running operations.

Inheritance
Awaitable
AsyncLROPoller
Generic
AsyncLROPoller

Constructor

AsyncLROPoller(client: Any, initial_response: Any, deserialization_callback: Callable[[Any], PollingReturnType_co], polling_method: AsyncPollingMethod[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
AsyncPollingMethod

The polling strategy to adopt

Methods

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.
result

Return the result of the long running operation.
status

Returns the current status string.
wait

Wait on the long running operation.

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: AsyncPollingMethod[PollingReturnType_co], continuation_token: str, **kwargs: Any) -> AsyncLROPoller[PollingReturnType_co]

Parameters

Name Description
polling_method
Required
continuation_token
Required

polling_method

Return the polling method associated to this poller.

polling_method() -> AsyncPollingMethod[PollingReturnType_co]

Returns

Type Description
AsyncPollingMethod

The polling method associated to this poller.

result

Return the result of the long running operation.

async result() -> PollingReturnType_co

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.

async wait() -> None

Exceptions

Type Description
HttpResponseError

Server problem with the query.