com.microsoft.azure

Class AzureClient

java.lang.Object

com.microsoft.rest.ServiceClient

com.microsoft.azure.AzureServiceClient

com.microsoft.azure.AzureClient

public final class AzureClient
extends AzureServiceClient

An instance of this class defines a ServiceClient that handles polling and retrying for long running operations when accessing Azure resources.

Constructor Summary

Constructors

Constructor and Description
AzureClient(AzureServiceClient serviceClient) Initializes an instance of this class with customized client metadata.

Method Summary

Modifier and Type	Method and Description
<T> rx.Single<PollingState<T>>	beginPostOrDeleteAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable, Type resourceType) Given an observable representing a deferred POST or DELETE action, this method returns Single object, when subscribed to it, the deferred action will be performed and emits the polling state containing information to track the progress of the action.
<T> rx.Single<PollingState<T>>	beginPutOrPatchAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable, Type resourceType) Given an observable representing a deferred PUT or PATCH action, this method returns Single object, when subscribed to it, the deferred action will be performed and emits the polling state containing information to track the progress of the action.
<T> rx.Observable<ServiceResponse<T>>	getPostOrDeleteResultAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable, Type resourceType) Handles an initial response from a POST or DELETE operation response by polling the status of the operation asynchronously, calling the user provided callback when the operation terminates.
<T,THeader> ServiceResponseWithHeaders<T,THeader>	getPostOrDeleteResultWithHeaders(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable, Type resourceType, Class<THeader> headerType) Handles an initial response from a POST or DELETE operation response by polling the status of the operation until the long running operation terminates.
<T,THeader> rx.Observable<ServiceResponseWithHeaders<T,THeader>>	getPostOrDeleteResultWithHeadersAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable, Type resourceType, Class<THeader> headerType) Handles an initial response from a POST or DELETE operation response by polling the status of the operation asynchronously, calling the user provided callback when the operation terminates.
<T> rx.Observable<ServiceResponse<T>>	getPutOrPatchResultAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable, Type resourceType) Handles an initial response from a PUT or PATCH operation response by polling the status of the operation asynchronously, once the operation finishes emits the final response.
<T,THeader> ServiceResponseWithHeaders<T,THeader>	getPutOrPatchResultWithHeaders(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable, Type resourceType, Class<THeader> headerType) Handles an initial response from a PUT or PATCH operation response by polling the status of the operation until the long running operation terminates.
<T,THeader> rx.Observable<ServiceResponseWithHeaders<T,THeader>>	getPutOrPatchResultWithHeadersAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable, Type resourceType, Class<THeader> headerType) Handles an initial response from a PUT or PATCH operation response by polling the status of the operation asynchronously, calling the user provided callback when the operation terminates.
Integer	longRunningOperationRetryTimeout() Gets the interval time between two long running operation polls.
<T> rx.Observable<PollingState<T>>	pollAsync(PollingState<T> pollingState, Type resourceType) Given a polling state representing state of an LRO operation, this method returns Observable object, when subscribed to it, a series of polling will be performed and emits each polling state to downstream.
<T> rx.Single<PollingState<T>>	pollSingleAsync(PollingState<T> pollingState, Type resourceType) Given a polling state representing state of a LRO operation, this method returns Single object, when subscribed to it, a single poll will be performed and emits the latest polling state.
void	setLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout) Sets the interval time between two long running operation polls.

Methods inherited from class com.microsoft.azure.AzureServiceClient

userAgent

Methods inherited from class com.microsoft.rest.ServiceClient

httpClient, restClient, retrofit, serializerAdapter

Methods inherited from class java.lang.Object

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

Constructor Detail

AzureClient

public AzureClient(AzureServiceClient serviceClient)

Initializes an instance of this class with customized client metadata.

Parameters:

serviceClient - the caller client that initiates the asynchronous request.

Method Detail

longRunningOperationRetryTimeout

public Integer longRunningOperationRetryTimeout()

Gets the interval time between two long running operation polls.

Returns:

the time in seconds.

setLongRunningOperationRetryTimeout

public void setLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)

Sets the interval time between two long running operation polls. Default is 30 seconds. Set to any negative value to let AzureClient ignore this setting.

Parameters:

longRunningOperationRetryTimeout - the time in seconds. Set to any negative value to let AzureClient ignore this setting.

getPutOrPatchResultWithHeaders

public <T,THeader> ServiceResponseWithHeaders<T,THeader> getPutOrPatchResultWithHeaders(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable,
                                                                                        Type resourceType,
                                                                                        Class<THeader> headerType)
                                                                                 throws CloudException,
                                                                                        InterruptedException,
                                                                                        IOException

Handles an initial response from a PUT or PATCH operation response by polling the status of the operation until the long running operation terminates.

Type Parameters:

T - the return type of the caller

THeader - the type of the response header

Parameters:

observable - the initial observable from the PUT or PATCH operation.

resourceType - the java.lang.reflect.Type of the resource.

headerType - the type of the response header

Returns:

the terminal response for the operation.

Throws:

CloudException - REST exception

InterruptedException - interrupted exception

IOException - thrown by deserialization

getPutOrPatchResultAsync

public <T> rx.Observable<ServiceResponse<T>> getPutOrPatchResultAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable,
                                                                      Type resourceType)

Handles an initial response from a PUT or PATCH operation response by polling the status of the operation asynchronously, once the operation finishes emits the final response.

Type Parameters:

T - the return type of the caller.

Parameters:

observable - the initial observable from the PUT or PATCH operation.

resourceType - the java.lang.reflect.Type of the resource.

Returns:

the observable of which a subscription will lead to a final response.

beginPutOrPatchAsync

public <T> rx.Single<PollingState<T>> beginPutOrPatchAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable,
                                                           Type resourceType)

Given an observable representing a deferred PUT or PATCH action, this method returns Single object, when subscribed to it, the deferred action will be performed and emits the polling state containing information to track the progress of the action. Note: this method does not implicitly introduce concurrency, by default the deferred action will be executed in scheduler (if any) set for the provided observable.

Type Parameters:

T - the type of the resource

Parameters:

observable - an observable representing a deferred PUT or PATCH operation.

resourceType - the java.lang.reflect.Type of the resource.

Returns:

the observable of which a subscription will lead PUT or PATCH action.

getPutOrPatchResultWithHeadersAsync

public <T,THeader> rx.Observable<ServiceResponseWithHeaders<T,THeader>> getPutOrPatchResultWithHeadersAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable,
                                                                                                            Type resourceType,
                                                                                                            Class<THeader> headerType)

Handles an initial response from a PUT or PATCH operation response by polling the status of the operation asynchronously, calling the user provided callback when the operation terminates.

Type Parameters:

T - the return type of the caller

THeader - the type of the response header

Parameters:

observable - the initial response from the PUT or PATCH operation.

resourceType - the java.lang.reflect.Type of the resource.

headerType - the type of the response header

Returns:

the task describing the asynchronous polling.

getPostOrDeleteResultWithHeaders

public <T,THeader> ServiceResponseWithHeaders<T,THeader> getPostOrDeleteResultWithHeaders(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable,
                                                                                          Type resourceType,
                                                                                          Class<THeader> headerType)
                                                                                   throws CloudException,
                                                                                          InterruptedException,
                                                                                          IOException

Handles an initial response from a POST or DELETE operation response by polling the status of the operation until the long running operation terminates.

Type Parameters:

T - the return type of the caller

THeader - the type of the response header

Parameters:

observable - the initial observable from the POST or DELETE operation.

resourceType - the java.lang.reflect.Type of the resource.

headerType - the type of the response header

Returns:

the terminal response for the operation.

Throws:

CloudException - REST exception

InterruptedException - interrupted exception

IOException - thrown by deserialization

getPostOrDeleteResultAsync

public <T> rx.Observable<ServiceResponse<T>> getPostOrDeleteResultAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable,
                                                                        Type resourceType)

Handles an initial response from a POST or DELETE operation response by polling the status of the operation asynchronously, calling the user provided callback when the operation terminates.

Type Parameters:

T - the return type of the caller.

Parameters:

observable - the initial response from the POST or DELETE operation.

resourceType - the java.lang.reflect.Type of the resource.

Returns:

the task describing the asynchronous polling.

beginPostOrDeleteAsync

public <T> rx.Single<PollingState<T>> beginPostOrDeleteAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable,
                                                             Type resourceType)

Given an observable representing a deferred POST or DELETE action, this method returns Single object, when subscribed to it, the deferred action will be performed and emits the polling state containing information to track the progress of the action.

Type Parameters:

T - the type of the resource

Parameters:

observable - an observable representing a deferred PUT or PATCH operation.

resourceType - the java.lang.reflect.Type of the resource.

Returns:

the observable of which a subscription will lead POST or DELETE action.

getPostOrDeleteResultWithHeadersAsync

public <T,THeader> rx.Observable<ServiceResponseWithHeaders<T,THeader>> getPostOrDeleteResultWithHeadersAsync(rx.Observable<retrofit2.Response<okhttp3.ResponseBody>> observable,
                                                                                                              Type resourceType,
                                                                                                              Class<THeader> headerType)

Handles an initial response from a POST or DELETE operation response by polling the status of the operation asynchronously, calling the user provided callback when the operation terminates.

Type Parameters:

T - the return type of the caller

THeader - the type of the response header

Parameters:

observable - the initial observable from the POST or DELETE operation.

resourceType - the java.lang.reflect.Type of the resource.

headerType - the type of the response header

Returns:

the task describing the asynchronous polling.

pollSingleAsync

public <T> rx.Single<PollingState<T>> pollSingleAsync(PollingState<T> pollingState,
                                                      Type resourceType)

Given a polling state representing state of a LRO operation, this method returns Single object, when subscribed to it, a single poll will be performed and emits the latest polling state. A poll will be performed only if the current polling state is not in terminal state. Note: this method does not implicitly introduce concurrency, by default the deferred action will be executed in scheduler (if any) set for the provided observable.

Type Parameters:

T - the type of the resource

Parameters:

pollingState - the current polling state

resourceType - the java.lang.reflect.Type of the resource.

Returns:

the observable of which a subscription will lead single polling action.

pollAsync

public <T> rx.Observable<PollingState<T>> pollAsync(PollingState<T> pollingState,
                                                    Type resourceType)

Given a polling state representing state of an LRO operation, this method returns Observable object, when subscribed to it, a series of polling will be performed and emits each polling state to downstream. Polling will completes when the operation finish with success, failure or exception.

Type Parameters:

T - the type of the resource

Parameters:

pollingState - the current polling state

resourceType - the java.lang.reflect.Type of the resource.

Returns:

the observable of which a subscription will lead multiple polling action.