Package com.azure.core.util.polling
Class SyncStatusCheckPollingStrategy<T,U>
java.lang.Object
com.azure.core.util.polling.SyncStatusCheckPollingStrategy<T,U>
- Type Parameters:
T
- the type of the response type from a polling call, or BinaryData if raw response body should be keptU
- the type of the final result object to deserialize into, or BinaryData if raw response body should be kept
- All Implemented Interfaces:
SyncPollingStrategy<T,
U>
Fallback polling strategy that doesn't poll but exits successfully if no other polling strategies are detected and
status code is 2xx.
-
Constructor Summary
ConstructorDescriptionCreates a status check polling strategy with a JSON serializer.SyncStatusCheckPollingStrategy
(ObjectSerializer serializer) Creates a status check polling strategy with a custom object serializer. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response.getResult
(PollingContext<T> pollingContext, TypeReference<U> resultType) Parses the response from the final GET call into the result type of the long-running operation.onInitialResponse
(Response<?> response, PollingContext<T> pollingContext, TypeReference<T> pollResponseType) Parses the initial response into aLongRunningOperationStatus
, and stores information useful for polling in thePollingContext
.poll
(PollingContext<T> context, TypeReference<T> pollResponseType) Parses the response from the polling URL into aPollResponse
, and stores information useful for further polling and final response in thePollingContext
.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.azure.core.util.polling.SyncPollingStrategy
cancel
-
Constructor Details
-
SyncStatusCheckPollingStrategy
public SyncStatusCheckPollingStrategy()Creates a status check polling strategy with a JSON serializer. -
SyncStatusCheckPollingStrategy
Creates a status check polling strategy with a custom object serializer.- Parameters:
serializer
- a custom serializer for serializing and deserializing polling responses
-
-
Method Details
-
canPoll
Description copied from interface:SyncPollingStrategy
Checks if this strategy is able to handle polling for this long-running operation based on the information in the initial response.- Specified by:
canPoll
in interfaceSyncPollingStrategy<T,
U> - Parameters:
initialResponse
- the response from the initial method call to activate the long-running operation- Returns:
- true if this polling strategy can handle the initial response, false if not
-
onInitialResponse
public PollResponse<T> onInitialResponse(Response<?> response, PollingContext<T> pollingContext, TypeReference<T> pollResponseType) Description copied from interface:SyncPollingStrategy
Parses the initial response into aLongRunningOperationStatus
, and stores information useful for polling in thePollingContext
. If the result is anything other thanLongRunningOperationStatus.IN_PROGRESS
, the long-running operation will be terminated and none of the other methods will be invoked.- Specified by:
onInitialResponse
in interfaceSyncPollingStrategy<T,
U> - Parameters:
response
- the response from the initial method call to activate the long-running operationpollingContext
- thePollingContext
for the current polling operationpollResponseType
- theTypeReference
of the response type from a polling call, or BinaryData if raw response body should be kept. This should match the generic parameterSyncPollingStrategy
.- Returns:
- the poll response containing the status and the response content
-
poll
Description copied from interface:SyncPollingStrategy
Parses the response from the polling URL into aPollResponse
, and stores information useful for further polling and final response in thePollingContext
. The result must have theLongRunningOperationStatus
specified, and the entire polling response content as aBinaryData
.- Specified by:
poll
in interfaceSyncPollingStrategy<T,
U> - Parameters:
context
- thePollingContext
for the current polling operationpollResponseType
- theTypeReference
of the response type from a polling call, or BinaryData if raw response body should be kept. This should match the generic parameterSyncPollingStrategy
.- Returns:
- the poll response containing the status and the response content
-
getResult
Description copied from interface:SyncPollingStrategy
Parses the response from the final GET call into the result type of the long-running operation.- Specified by:
getResult
in interfaceSyncPollingStrategy<T,
U> - Parameters:
pollingContext
- thePollingContext
for the current polling operationresultType
- theTypeReference
of the final result object to deserialize into, or BinaryData if raw response body should be kept.- Returns:
- the final result
-