com.microsoft.azure

Class PollingState<T>

java.lang.Object

com.microsoft.azure.PollingState<T>

Type Parameters:

T - the type of the resource the operation returns.

public class PollingState<T>
extends Object

An instance of this class defines polling status of a long running operation.

Method Summary

Modifier and Type	Method and Description
String	azureAsyncOperationHeaderLink() Gets the value captured from Azure-AsyncOperation header.
static <T> PollingState<T>	create(retrofit2.Response<okhttp3.ResponseBody> response, int defaultRetryTimeout, Type resourceType, SerializerAdapter<?> serializerAdapter) Creates a polling state.
static <ResultT> PollingState<ResultT>	createFromJSONString(String serializedPollingState) Creates PollingState from the json string.
static <ResultT> PollingState<ResultT>	createFromPollingState(PollingState<?> other, ResultT result) Creates PollingState from another polling state.
String	locationHeaderLink() Gets the value captured from Location header.
T	resource() Gets the resource.
retrofit2.Response<okhttp3.ResponseBody>	response() Gets the operation response.
String	serialize()
String	status() Gets the polling status.
int	statusCode() Gets the polling HTTP status code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static <T> PollingState<T> create(retrofit2.Response<okhttp3.ResponseBody> response,
                                         int defaultRetryTimeout,
                                         Type resourceType,
                                         SerializerAdapter<?> serializerAdapter)
                                  throws IOException

Creates a polling state.

Type Parameters:

T - the result type

Parameters:

response - the response from Retrofit REST call that initiate the long running operation.

defaultRetryTimeout - the long running operation retry timeout.

resourceType - the type of the resource the long running operation returns

serializerAdapter - the adapter for the Jackson object mapper

Returns:

the polling state

Throws:

IOException - thrown by deserialization

createFromJSONString

public static <ResultT> PollingState<ResultT> createFromJSONString(String serializedPollingState)

Creates PollingState from the json string.

Type Parameters:

ResultT - the result that the poll operation produces

Parameters:

serializedPollingState - polling state as json string

Returns:

the polling state

createFromPollingState

public static <ResultT> PollingState<ResultT> createFromPollingState(PollingState<?> other,
                                                                     ResultT result)

Creates PollingState from another polling state.

Type Parameters:

ResultT - the result that the poll operation produces

Parameters:

other - other polling state

result - the final result of the LRO

Returns:

the polling state

serialize

public String serialize()

Returns:

the polling state in json string format

resource

public T resource()

Gets the resource.

Returns:

the resource.

response

public retrofit2.Response<okhttp3.ResponseBody> response()

Gets the operation response.

Returns:

the operation response.

status

public String status()

Gets the polling status.

Returns:

the polling status.

statusCode

public int statusCode()

Gets the polling HTTP status code.

Returns:

the polling HTTP status code.

azureAsyncOperationHeaderLink

public String azureAsyncOperationHeaderLink()

Gets the value captured from Azure-AsyncOperation header.

Returns:

the link in the header.

locationHeaderLink

public String locationHeaderLink()

Gets the value captured from Location header.

Returns:

the link in the header.