SyncPollingStrategy<T,U> Interface
Type Parameters
- T
the TypeReference of the response type from a polling call, or BinaryData if raw response body should be kept
- U
the TypeReference of the final result object to deserialize into, or BinaryData if raw response body should be kept
public interface SyncPollingStrategy<T,U>
Represents a known strategy for polling a long-running operation in Azure.
The methods in the polling strategy will be invoked from the SyncPoller<T,U>. The order of the invocations is:
- canPoll(Response<?> initialResponse) - exits if returns false
- onInitialResponse(Response<?> response, PollingContext<T> pollingContext, TypeReference<T> pollResponseType) - immediately after canPoll(Response<?> initialResponse) returns true
- poll(PollingContext<T> pollingContext, TypeReference<T> pollResponseType) - invoked after each polling interval, if the last polling response indicates an "In Progress" status. Returns a PollResponse<T> with the latest status
- getResult(PollingContext<T> pollingContext, TypeReference<U> resultType) - invoked when the last polling response indicates a "Successfully Completed" status. Returns the final result of the given type
If the user decides to cancel the PollingContext<T> or SyncPoller<T,U>, the cancel(PollingContext<T> pollingContext, PollResponse<T> initialResponse) method will be invoked. If the strategy doesn't support cancellation, an error will be returned.
Users are not expected to provide their own implementation of this interface. Built-in polling strategies in this library and other client libraries are often sufficient for handling polling in most long-running operations in Azure. When there are special scenarios, built-in polling strategies can be inherited and select methods can be overridden to accomplish the polling requirements, without writing an entire polling strategy from scratch.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| abstract boolean |
canPoll(Response<?> initialResponse)
Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response. |
| default T |
cancel(PollingContext<T> pollingContext, PollResponse<T> initialResponse)
Cancels the long-running operation if service supports cancellation. |
| abstract U |
getResult(PollingContext<T> pollingContext, TypeReference<U> resultType)
Parses the response from the final GET call into the result type of the long-running operation. |
|
abstract
Poll |
onInitialResponse(Response<?> response, PollingContext<T> pollingContext, TypeReference<T> pollResponseType)
Parses the initial response into a LongRunningOperationStatus, and stores information useful for polling in the PollingContext<T>. |
|
abstract
Poll |
poll(PollingContext<T> pollingContext, TypeReference<T> pollResponseType)
Parses the response from the polling URL into a PollResponse<T>, and stores information useful for further polling and final response in the PollingContext<T>. |
Method Details
canPoll
public abstract boolean canPoll(Response initialResponse)
Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response.
Parameters:
Returns:
cancel
public default T cancel(PollingContext
Cancels the long-running operation if service supports cancellation. If service does not support cancellation then the implementer should throw an IllegalStateException with an error message indicating absence of cancellation.
Implementing this method is optional - by default, cancellation will not be supported unless overridden.
Parameters:
Returns:
getResult
public abstract U getResult(PollingContext
Parses the response from the final GET call into the result type of the long-running operation.
Parameters:
Returns:
onInitialResponse
public abstract PollResponse
Parses the initial response into a LongRunningOperationStatus, and stores information useful for polling in the PollingContext<T>. If the result is anything other than IN_PROGRESS, the long-running operation will be terminated and none of the other methods will be invoked.
Parameters:
Returns:
poll
public abstract PollResponse
Parses the response from the polling URL into a PollResponse<T>, and stores information useful for further polling and final response in the PollingContext<T>. The result must have the LongRunningOperationStatus specified, and the entire polling response content as a BinaryData.
Parameters:
Returns:
