FileRequestOptions (Microsoft Azure Storage Client SDK 2.2.0 API)

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

public final class FileRequestOptions
extends RequestOptions

Represents a set of options that may be specified on a request.

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`protected static FileRequestOptions`	`applyDefaults(FileRequestOptions options, CloudFileClient client)` Uses the concurrent request count from the specified client if `null`, sets a default value for everything else, and sets defaults as defined in the parent class.
`protected static FileRequestOptions`	`applyDefaults(FileRequestOptions options, CloudFileClient client, boolean setStartTime)` Uses the concurrent request count from the specified client if `null`, sets a default value for everything else, and sets defaults as defined in the parent class.
`Integer`	`getConcurrentRequestCount()` Gets the concurrent number of simultaneous requests per operation.
`Boolean`	`getDisableContentMD5Validation()` Gets whether download and `FileInputStream` methods should ignore the file's ContentMD5 header.
`Boolean`	`getStoreFileContentMD5()` Gets whether the file's ContentMD5 header should be set on uploads.
`Boolean`	`getUseTransactionalContentMD5()` Gets whether a range PUT or GET operation will use the Content-MD5 header to enforce transactional security.
`void`	`setConcurrentRequestCount(Integer concurrentRequestCount)` Sets the concurrent number of simultaneous requests per operation.
`void`	`setDisableContentMD5Validation(Boolean disableContentMD5Validation)` Sets whether download and `FileInputStream` methods should ignore the file's ContentMD5 header.
`void`	`setLocationMode(LocationMode locationMode)` Sets the `LocationMode` for this request.
`void`	`setStoreFileContentMD5(Boolean storeFileContentMD5)` Sets whether the file's ContentMD5 header should be set on uploads.
`void`	`setUseTransactionalContentMD5(Boolean useTransactionalContentMD5)` Sets whether a range PUT or GET operation will use the Content-MD5 header to enforce transactional security.

Methods inherited from class com.microsoft.azure.storage.RequestOptions
applyBaseDefaultsInternal, getLocationMode, getMaximumExecutionTimeInMs, getOperationExpiryTimeInMs, getRetryPolicyFactory, getTimeoutIntervalInMs, populateRequestOptions, setMaximumExecutionTimeInMs, setRetryPolicyFactory, setTimeoutIntervalInMs

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

- Constructor Detail
  - FileRequestOptions
```
public FileRequestOptions()
```
    Creates an instance of the FileRequestOptions class.
  - FileRequestOptions
```
public FileRequestOptions(FileRequestOptions other)
```
    Creates an instance of the FileRequestOptions class by copying values from another FileRequestOptions instance.
    
    Parameters:
    other - A FileRequestOptions object which represents the file request options to copy.
- Method Detail
  - applyDefaults
```
protected static final FileRequestOptions applyDefaults(FileRequestOptions options,
                               CloudFileClient client)
```
    Uses the concurrent request count from the specified client if null, sets a default value for everything else, and sets defaults as defined in the parent class.
    
    Parameters:
    options - The input options to copy from when applying defaults
    client - A CloudFileClient object that represents the service client used to set the default timeout interval and retry policy, if they are null. Additionally, if the concurrentRequestCount field's value is null, it will be set to the value specified by the cloud file client's CloudFileClient#getConcurrentRequestCount method.
  - applyDefaults
```
protected static final FileRequestOptions applyDefaults(FileRequestOptions options,
                               CloudFileClient client,
                               boolean setStartTime)
```
    Uses the concurrent request count from the specified client if null, sets a default value for everything else, and sets defaults as defined in the parent class.
    
    Parameters:
    options - The input options to copy from when applying defaults
    client - A CloudFileClient object that represents the service client used to set the default timeout interval and retry policy, if they are null. Additionally, if the concurrentRequestCount field's value is null, it will be set to the value specified by the cloud blob client's CloudFileClient#getConcurrentRequestCount method.
    setStartTime - whether to initialize the startTimeInMs field, or not
  - getConcurrentRequestCount
```
public Integer getConcurrentRequestCount()
```
    Gets the concurrent number of simultaneous requests per operation. For more information about concurrent request count defaults, see setConcurrentRequestCount(Integer).
    
    Returns:
    the concurrentRequestCount
  - getUseTransactionalContentMD5
```
public Boolean getUseTransactionalContentMD5()
```
    Gets whether a range PUT or GET operation will use the Content-MD5 header to enforce transactional security. All partial file uploads or downloads will be restricted to 4 MB. For more information about transactional content MD5 defaults, see setUseTransactionalContentMD5(Boolean).
    
    Returns:
    the useTransactionalContentMD5
  - getStoreFileContentMD5
```
public Boolean getStoreFileContentMD5()
```
    Gets whether the file's ContentMD5 header should be set on uploads. For more information about storing file content MD5 defaults, see setStoreFileContentMD5(Boolean) .
    
    Returns:
    the storeFileContentMD5
  - getDisableContentMD5Validation
```
public Boolean getDisableContentMD5Validation()
```
    Gets whether download and FileInputStream methods should ignore the file's ContentMD5 header. For more information about disabling content MD5 validation defaults, see setDisableContentMD5Validation(Boolean) .
    
    Returns:
    the disableContentMD5Validation
  - setConcurrentRequestCount
```
public void setConcurrentRequestCount(Integer concurrentRequestCount)
```
    Sets the concurrent number of simultaneous requests per operation.
    The default concurrent request count is set in the client and is by default 1, indicating no concurrency. You can change the concurrent request count on this request by setting this property. You can also change the value on the FileServiceConstants#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that concurrent request count.
    
    Parameters:
    concurrentRequestCount - the concurrentRequestCount to set
  - setUseTransactionalContentMD5
```
public void setUseTransactionalContentMD5(Boolean useTransactionalContentMD5)
```
    Sets whether a range PUT or GET operation will use the Content-MD5 header to enforce transactional security.
    The default useTransactionalContentMD5 value is set in the client and is by default false. You can change the useTransactionalContentMD5 value on this request by setting this property. You can also change the value on the FileServiceClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that useTransactionalContentMD5 value.
    
    Parameters:
    useTransactionalContentMD5 - the useTransactionalContentMD5 to set
  - setStoreFileContentMD5
```
public void setStoreFileContentMD5(Boolean storeFileContentMD5)
```
    Sets whether the file's ContentMD5 header should be set on uploads.
    The default storeFileContentMD5 value is set in the client and is by default true. You can change the storeFileContentMD5 value on this request by setting this property. You can also change the value on the FileServiceClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that storeFileContentMD5 value.
    
    Parameters:
    storeFileContentMD5 - the storeFileContentMD5 to set
  - setDisableContentMD5Validation
```
public void setDisableContentMD5Validation(Boolean disableContentMD5Validation)
```
    Sets whether download and FileInputStream methods should ignore the file's ContentMD5 header.
    The default disableContentMD5Validation value is set in the client and is by default false. You can change the disableContentMD5Validation value on this request by setting this property. You can also change the value on the FileServiceClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that disableContentMD5Validation value.
    
    Parameters:
    disableContentMD5Validation - the disableContentMD5Validation to set
  - setLocationMode
```
public final 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.
    
    Overrides:
    
    setLocationMode in class RequestOptions
    
    Parameters:
    locationMode - the locationMode to set

/** 
* 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 FileRequestOptions

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.azure.storage.RequestOptions

Methods inherited from class java.lang.Object

Constructor Detail

FileRequestOptions

FileRequestOptions

Method Detail

applyDefaults

applyDefaults

getConcurrentRequestCount

getUseTransactionalContentMD5

getStoreFileContentMD5

getDisableContentMD5Validation

setConcurrentRequestCount

setUseTransactionalContentMD5

setStoreFileContentMD5

setDisableContentMD5Validation

setLocationMode