PollingMethod Class
ABC class for polling method.
Constructor
PollingMethod()
Methods
finished |
Check if the polling operation is finished. |
from_continuation_token |
Recreate the poller from a continuation token. |
get_continuation_token |
Return a continuation token that allows to restart the poller later. |
initialize | |
resource |
Return the resource built by the polling operation. |
run |
Run the polling method. This method should be implemented to perform the actual polling logic. |
status |
Return the current status of the polling operation. |
finished
Check if the polling operation is finished.
finished() -> bool
Returns
Type | Description |
---|---|
True if the polling operation is finished, False otherwise. |
from_continuation_token
Recreate the poller from a continuation token.
from_continuation_token(continuation_token: str, **kwargs: Any) -> Tuple[Any, Any, Any]
Parameters
Name | Description |
---|---|
continuation_token
Required
|
The continuation token to recreate the poller from. |
Returns
Type | Description |
---|---|
A tuple containing the client, initial response, and deserialization callback. |
get_continuation_token
Return a continuation token that allows to restart the poller later.
get_continuation_token() -> str
Returns
Type | Description |
---|---|
An opaque continuation token. |
initialize
initialize(client: Any, initial_response: Any, deserialization_callback: Any) -> None
Parameters
Name | Description |
---|---|
client
Required
|
|
initial_response
Required
|
|
deserialization_callback
Required
|
|
resource
Return the resource built by the polling operation.
resource() -> PollingReturnType_co
Returns
Type | Description |
---|---|
The resource built by the polling operation. |
run
Run the polling method. This method should be implemented to perform the actual polling logic.
run() -> None
Returns
Type | Description |
---|---|
None |
status
Return the current status of the polling operation.
status() -> str
Returns
Type | Description |
---|---|
The current status of the polling operation. |