BlobRequestOptions (Microsoft Azure Storage Client SDK 2.2.0 API)

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

public final class BlobRequestOptions
extends RequestOptions

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

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`protected static BlobRequestOptions`	`applyDefaults(BlobRequestOptions options, BlobType blobType, CloudBlobClient 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 BlobRequestOptions`	`applyDefaults(BlobRequestOptions options, BlobType blobType, CloudBlobClient 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 `BlobInputStream` methods should ignore the blob's ContentMD5 header.
`Integer`	`getSingleBlobPutThresholdInBytes()` Gets the threshold size used for writing a single blob.
`Boolean`	`getStoreBlobContentMD5()` Gets whether the blob'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 `BlobInputStream` methods should ignore the blob's ContentMD5 header.
`void`	`setSingleBlobPutThresholdInBytes(Integer singleBlobPutThresholdInBytes)` Sets the threshold size used for writing a single blob to use.
`void`	`setStoreBlobContentMD5(Boolean storeBlobContentMD5)` Sets whether the blob'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, setLocationMode, setMaximumExecutionTimeInMs, setRetryPolicyFactory, setTimeoutIntervalInMs

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

- Constructor Detail
  - BlobRequestOptions
```
public BlobRequestOptions()
```
    Creates an instance of the BlobRequestOptions class.
  - BlobRequestOptions
```
public BlobRequestOptions(BlobRequestOptions other)
```
    Creates an instance of the BlobRequestOptions class by copying values from another BlobRequestOptions instance.
    
    Parameters:
    other - A BlobRequestOptions object which represents the blob request options to copy.
- Method Detail
  - applyDefaults
```
protected static final BlobRequestOptions applyDefaults(BlobRequestOptions options,
                               BlobType blobType,
                               CloudBlobClient 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
    blobType - BlobType of the current operation
    client - A CloudBlobClient 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 CloudBlobClient.getConcurrentRequestCount() method.
  - applyDefaults
```
protected static final BlobRequestOptions applyDefaults(BlobRequestOptions options,
                               BlobType blobType,
                               CloudBlobClient 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
    blobType - BlobType of the current operation
    client - A CloudBlobClient 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 CloudBlobClient.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 blob uploads or downloads will be restricted to 4 MB. For more information about transactional content MD5 defaults, see setUseTransactionalContentMD5(Boolean).
    
    Returns:
    the useTransactionalContentMD5
  - getStoreBlobContentMD5
```
public Boolean getStoreBlobContentMD5()
```
    Gets whether the blob's ContentMD5 header should be set on uploads. This field is not supported for page blobs. For more information about storing blob content MD5 defaults, see setStoreBlobContentMD5(Boolean) .
    
    Returns:
    the storeBlobContentMD5
  - getDisableContentMD5Validation
```
public Boolean getDisableContentMD5Validation()
```
    Gets whether download and BlobInputStream methods should ignore the blob's ContentMD5 header. For more information about disabling content MD5 validation defaults, see setDisableContentMD5Validation(Boolean) .
    
    Returns:
    the disableContentMD5Validation
  - getSingleBlobPutThresholdInBytes
```
public Integer getSingleBlobPutThresholdInBytes()
```
    Gets the threshold size used for writing a single blob. For more information about the threshold size defaults, see setSingleBlobPutThresholdInBytes(Integer).
    
    Returns:
    The maximum size, in bytes, of a blob that may be uploaded as a single blob, ranging from 1 to 64 MB inclusive. If a blob size is above the threshold, it will be uploaded as blocks.
  - 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 BlobServiceClient#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. All partial blob uploads or downloads will be restricted to 4 MB.
    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 BlobServiceClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that useTransactionalContentMD5 value.
    
    Parameters:
    useTransactionalContentMD5 - the useTransactionalContentMD5 to set
  - setStoreBlobContentMD5
```
public void setStoreBlobContentMD5(Boolean storeBlobContentMD5)
```
    Sets whether the blob's ContentMD5 header should be set on uploads. This field is not supported for page blobs.
    The default storeBlobContentMD5 value is set in the client and is by default true for block blobs. You can change the storeBlobContentMD5 value on this request by setting this property. You can also change the value on the BlobServiceClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that storeBlobContentMD5 value.
    
    Parameters:
    storeBlobContentMD5 - the storeBlobContentMD5 to set
  - setDisableContentMD5Validation
```
public void setDisableContentMD5Validation(Boolean disableContentMD5Validation)
```
    Sets whether download and BlobInputStream methods should ignore the blob'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 BlobServiceClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that disableContentMD5Validation value.
    
    Parameters:
    disableContentMD5Validation - the disableContentMD5Validation to set
  - setSingleBlobPutThresholdInBytes
```
public void setSingleBlobPutThresholdInBytes(Integer singleBlobPutThresholdInBytes)
```
    Sets the threshold size used for writing a single blob to use.
    The default threshold size is set in the client and is by default 32MB. You can change the threshold size on this request by setting this property. You can also change the value on the BlobServiceClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that threshold size.
    
    Parameters:
    singleBlobPutThresholdInBytes - The maximum size, in bytes, of a blob that may be uploaded as a single blob, ranging from 1 MB to 64 MB inclusive. If a blob size is above the threshold, it will be uploaded as blocks.
    
    Throws:
    
    IllegalArgumentException - If minimumReadSize is less than 1 MB or greater than 64 MB.

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

BlobRequestOptions

BlobRequestOptions

Method Detail

applyDefaults

applyDefaults

getConcurrentRequestCount

getUseTransactionalContentMD5

getStoreBlobContentMD5

getDisableContentMD5Validation

getSingleBlobPutThresholdInBytes

setConcurrentRequestCount

setUseTransactionalContentMD5

setStoreBlobContentMD5

setDisableContentMD5Validation

setSingleBlobPutThresholdInBytes