Package com.azure.core.util.polling

Class DefaultPollingStrategy<T,U>

java.lang.Object

com.azure.core.util.polling.DefaultPollingStrategy<T,U>

Type Parameters:

T - the type of the response type from a polling call, or BinaryData if raw response body should be kept

U - the type of the final result object to deserialize into, or BinaryData if raw response body should be kept

All Implemented Interfaces:

PollingStrategy<T,U>

public final class DefaultPollingStrategy<T,U>
extends Object
implements PollingStrategy<T,U>

The default polling strategy to use with Azure data plane services. The default polling strategy will attempt 3 known strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order. The first strategy that can poll on the initial response will be used. The created chained polling strategy is capable of handling most of the polling scenarios in Azure.

Constructor Summary

Constructors

Constructor	Description
DefaultPollingStrategy(HttpPipeline httpPipeline)	Creates a chained polling strategy with 3 known polling strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order, with a JSON serializer.
DefaultPollingStrategy(HttpPipeline httpPipeline, JsonSerializer serializer)	Creates a chained polling strategy with 3 known polling strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order, with a custom serializer.
DefaultPollingStrategy(HttpPipeline httpPipeline, JsonSerializer serializer, Context context)	Creates a chained polling strategy with 3 known polling strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order, with a custom serializer.
DefaultPollingStrategy(HttpPipeline httpPipeline, String endpoint, JsonSerializer serializer, Context context)	Creates a chained polling strategy with 3 known polling strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order, with a custom serializer.
DefaultPollingStrategy(PollingStrategyOptions pollingStrategyOptions)	Creates a chained polling strategy with 3 known polling strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order, with a custom serializer.

Method Summary

Modifier and Type	Method	Description
Mono<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.
Mono<U>	getResult(PollingContext<T> context, TypeReference<U> resultType)	Parses the response from the final GET call into the result type of the long-running operation.
Mono<PollResponse<T>>	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.
Mono<PollResponse<T>>	poll(PollingContext<T> context, TypeReference<T> pollResponseType)	Parses the response from the polling URL into a PollResponse, and stores information useful for further polling and final response in the PollingContext.

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

cancel

Constructor Details

DefaultPollingStrategy

public DefaultPollingStrategy(HttpPipeline httpPipeline)

Creates a chained polling strategy with 3 known polling strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order, with a JSON serializer.

Parameters:

httpPipeline - an instance of HttpPipeline to send requests with

Throws:

NullPointerException - If httpPipeline is null.

DefaultPollingStrategy

public DefaultPollingStrategy(HttpPipeline httpPipeline,
 JsonSerializer serializer)

Creates a chained polling strategy with 3 known polling strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order, with a custom serializer.

Parameters:

httpPipeline - an instance of HttpPipeline to send requests with

serializer - a custom serializer for serializing and deserializing polling responses

Throws:

NullPointerException - If httpPipeline is null.

DefaultPollingStrategy

public DefaultPollingStrategy(HttpPipeline httpPipeline,
 JsonSerializer serializer,
 Context context)

Creates a chained polling strategy with 3 known polling strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order, with a custom serializer.

Parameters:

httpPipeline - an instance of HttpPipeline to send requests with

serializer - a custom serializer for serializing and deserializing polling responses

context - an instance of Context

Throws:

NullPointerException - If httpPipeline is null.

DefaultPollingStrategy

public DefaultPollingStrategy(HttpPipeline httpPipeline,
 String endpoint,
 JsonSerializer serializer,
 Context context)

Creates a chained polling strategy with 3 known polling strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order, with a custom serializer.

Parameters:

httpPipeline - an instance of HttpPipeline to send requests with.

endpoint - an endpoint for creating an absolute path when the path itself is relative.

serializer - a custom serializer for serializing and deserializing polling responses.

context - an instance of Context.

Throws:

NullPointerException - If httpPipeline is null.

DefaultPollingStrategy

public DefaultPollingStrategy(PollingStrategyOptions pollingStrategyOptions)

Creates a chained polling strategy with 3 known polling strategies, OperationResourcePollingStrategy, LocationPollingStrategy, and StatusCheckPollingStrategy, in this order, with a custom serializer.

Parameters:

pollingStrategyOptions - options to configure this polling strategy.

Throws:

NullPointerException - If pollingStrategyOptions is null.

Method Details

getResult

public Mono<U> getResult(PollingContext<T> context,
 TypeReference<U> resultType)

Description copied from interface: PollingStrategy

Parses the response from the final GET call into the result type of the long-running operation.

Specified by:

getResult in interface PollingStrategy<T,U>

Parameters:

context - the PollingContext for the current polling operation

resultType - the TypeReference of the final result object to deserialize into, or BinaryData if raw response body should be kept.

Returns:

a publisher emitting the final result

canPoll

public Mono<Boolean> canPoll(Response<?> initialResponse)

Description copied from interface: PollingStrategy

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 interface PollingStrategy<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 Mono<PollResponse<T>> onInitialResponse(Response<?> response,
 PollingContext<T> pollingContext,
 TypeReference<T> pollResponseType)

Description copied from interface: PollingStrategy

Parses the initial response into a LongRunningOperationStatus, and stores information useful for polling in the PollingContext. If the result is anything other than LongRunningOperationStatus.IN_PROGRESS, the long-running operation will be terminated and none of the other methods will be invoked.

Specified by:

onInitialResponse in interface PollingStrategy<T,U>

Parameters:

response - the response from the initial method call to activate the long-running operation

pollingContext - the PollingContext for the current polling operation

pollResponseType - the TypeReference of the response type from a polling call, or BinaryData if raw response body should be kept. This should match the generic parameter PollingStrategy.

Returns:

a publisher emitting the poll response containing the status and the response content

poll

public Mono<PollResponse<T>> poll(PollingContext<T> context,
 TypeReference<T> pollResponseType)

Description copied from interface: PollingStrategy

Parses the response from the polling URL into a PollResponse, and stores information useful for further polling and final response in the PollingContext. The result must have the LongRunningOperationStatus specified, and the entire polling response content as a BinaryData.

Specified by:

poll in interface PollingStrategy<T,U>

Parameters:

context - the PollingContext for the current polling operation

pollResponseType - the TypeReference of the response type from a polling call, or BinaryData if raw response body should be kept. This should match the generic parameter PollingStrategy.

Returns:

a publisher emitting the poll response containing the status and the response content