RequestOptions (Microsoft Azure Storage Android Client SDK 2.0.0 API)

java.lang.Object
- com.microsoft.azure.storage.RequestOptions

Direct Known Subclasses:

BlobRequestOptions, FileRequestOptions, QueueRequestOptions, TableRequestOptions
```
public abstract class RequestOptions
extends Object
```
Represents the options to use while processing a given request.

Constructor Summary

Constructors
Constructor and Description
`RequestOptions()` Creates an instance of the `RequestOptions` class.
`RequestOptions(RequestOptions other)` Creates an instance of the `RequestOptions` class by copying values from another `RequestOptions` instance.

Method Summary

Methods
Modifier and Type	Method and Description
`LocationMode`	`getLocationMode()` Gets the default location mode for this request.
`Integer`	`getMaximumExecutionTimeInMs()` Gets the maximum execution time for this request.
`Long`	`getOperationExpiryTimeInMs()` RESERVED FOR INTERNAL USE.
`RetryPolicyFactory`	`getRetryPolicyFactory()` Gets the retry policy to use for this request.
`Integer`	`getTimeoutIntervalInMs()` Returns the timeout value for this request.
`void`	`setLocationMode(LocationMode locationMode)` Sets the `LocationMode` for this request.
`void`	`setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs)` Sets the maximum execution time to use when making this request.
`void`	`setRetryPolicyFactory(RetryPolicyFactory retryPolicyFactory)` Sets the RetryPolicyFactory object to use for this request.
`void`	`setTimeoutIntervalInMs(Integer timeoutIntervalInMs)` Sets the timeout to use when making this request.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RequestOptions
```
public RequestOptions()
```
    Creates an instance of the RequestOptions class.
  - RequestOptions
```
public RequestOptions(RequestOptions other)
```
    Creates an instance of the RequestOptions class by copying values from another RequestOptions instance.
    
    Parameters:
    other - A RequestOptions object that represents the request options to copy.
- Method Detail
  - getRetryPolicyFactory
```
public final RetryPolicyFactory getRetryPolicyFactory()
```
    Gets the retry policy to use for this request. For more information about the retry policy defaults, see setRetryPolicyFactory(RetryPolicyFactory).
    
    Returns:
    An RetryPolicyFactory object that represents the current retry policy.
    See Also:
    RetryPolicy, RetryExponentialRetry, RetryLinearRetry, RetryNoRetry
  - getTimeoutIntervalInMs
```
public final Integer getTimeoutIntervalInMs()
```
    Returns the timeout value for this request. For more information about the timeout defaults, see setTimeoutIntervalInMs(Integer).
    
    Returns:
    The current timeout value, in milliseconds, for this request.
  - getLocationMode
```
public final LocationMode getLocationMode()
```
    Gets the default location mode for this request. For more information about location mode, see setLocationMode(LocationMode).
    
    Returns:
    A LocationMode object that represents the location mode for this request.
  - getMaximumExecutionTimeInMs
```
public Integer getMaximumExecutionTimeInMs()
```
    Gets the maximum execution time for this request. For more information about maximum execution time defaults, see setMaximumExecutionTimeInMs(Integer).
    
    Returns:
    The current maximum execution time, in milliseconds, for this request.
  - getOperationExpiryTimeInMs
```
public Long getOperationExpiryTimeInMs()
```
    RESERVED FOR INTERNAL USE. Returns the time at which this operation expires. This is computed by adding the time the operation begins and the maximum execution time and will be null if maximum execution time is null. For more information about maximum execution time, see setMaximumExecutionTimeInMs(Integer).
    
    Returns:
    The current operation expiry time, in milliseconds, for this request.
  - setRetryPolicyFactory
```
public final void setRetryPolicyFactory(RetryPolicyFactory retryPolicyFactory)
```
    Sets the RetryPolicyFactory object to use for this request.
    The default RetryPolicyFactory is set in the client and is by default RetryExponentialRetry. You can change the RetryPolicyFactory on this request by setting this property. You can also change the value on the ServiceClient.getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that RetryPolicyFactory.
    
    Parameters:
    retryPolicyFactory - the RetryPolicyFactory object to use when making service requests.
    See Also:
    RetryPolicy, RetryExponentialRetry, RetryLinearRetry, RetryNoRetry
  - setTimeoutIntervalInMs
```
public final void setTimeoutIntervalInMs(Integer timeoutIntervalInMs)
```
    Sets the timeout to use when making this request.
    The server timeout interval begins at the time that the complete request has been received by the service, and the server begins processing the response. If the timeout interval elapses before the response is returned to the client, the operation times out. The timeout interval resets with each retry, if the request is retried.
    The default server timeout is set in the client and is by default null, indicating no server timeout. You can change the server timeout on this request by setting this property. You can also change the value on the ServiceClient.getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that server timeout.
    
    Parameters:
    timeoutIntervalInMs - The timeout, in milliseconds, to use for this request.
  - setLocationMode
```
public void setLocationMode(LocationMode locationMode)
```
    Sets the LocationMode for this request.
    The default LocationMode is set in the client and is by default LocationMode.PRIMARY_ONLY. You can change the LocationMode on this request by setting this property. You can also change the value on the ServiceClient.getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that LocationMode.
    
    Parameters:
    locationMode - the locationMode to set
  - setMaximumExecutionTimeInMs
```
public void setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs)
```
    Sets the maximum execution time to use when making this request.
    The maximum execution time interval begins at the time that the client begins building the request. The maximum execution time is checked intermittently while uploading data, downloading data, and before executing retries. The service will continue to upload, download, and retry until the maximum execution time is reached. At that time, any partial uploads or downloads will be cancelled and an exception will be thrown.
    The default maximum execution is set in the client and is by default null, indicating no maximum time. You can change the maximum execution time on this request by setting this property. You can also change the value on the ServiceClient.getDefaultRequestOptions() object so that all subsequent requests made via the service client will use the maximum execution time.
    
    Parameters:
    maximumExecutionTimeInMs - The maximum execution time, in milliseconds, to use for this request.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class RequestOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestOptions

RequestOptions

Method Detail

getRetryPolicyFactory

getTimeoutIntervalInMs

getLocationMode

getMaximumExecutionTimeInMs

getOperationExpiryTimeInMs

setRetryPolicyFactory

setTimeoutIntervalInMs

setLocationMode

setMaximumExecutionTimeInMs