Package com.azure.core.experimental.util.polling

Class OperationLocationPollingStrategy<T,U>

java.lang.Object

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

com.azure.core.experimental.util.polling.OperationLocationPollingStrategy<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 class OperationLocationPollingStrategy<T,U>
extends OperationResourcePollingStrategy<T,U>

Implements an operation location polling strategy, from Operation-Location.

Constructor Summary

Constructors

Constructor	Description
OperationLocationPollingStrategy(PollingStrategyOptions pollingStrategyOptions)	Creates an instance of the operation resource polling strategy.

Method Summary

Modifier and Type	Method	Description
Mono<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.
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.

Methods inherited from class com.azure.core.util.polling.OperationResourcePollingStrategy

canPoll, poll

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

OperationLocationPollingStrategy

public OperationLocationPollingStrategy(PollingStrategyOptions pollingStrategyOptions)

Creates an instance of the operation resource polling strategy.

Parameters:

pollingStrategyOptions - options to configure this polling strategy.

Throws:

NullPointerException - if pollingStrategyOptions is null.

Method Details

onInitialResponse

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

Overrides:

onInitialResponse in class OperationResourcePollingStrategy<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

getResult

public Mono<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.

Specified by:

getResult in interface PollingStrategy<T,U>

Overrides:

getResult in class OperationResourcePollingStrategy<T,U>

Parameters:

pollingContext - 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