BlobRequestOptions Class

Definition

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

public class BlobRequestOptions extends RequestOptions
Inheritance
java.lang.Object
BlobRequestOptions

Inherited Members

Constructors

BlobRequestOptions()

Creates an instance of the class.

BlobRequestOptions(final BlobRequestOptions other)

Creates an instance of the class by copying values from another instance.

Methods

applyDefaults(final BlobRequestOptions modifiedOptions, final BlobType blobtype)

Applies defaults to the options passed in.

assertNoEncryptionPolicyOrStrictMode()

Assert that if validation is on, an encryption policy is not specified.

assertPolicyIfRequired()

Assert that if strict mode is on, an encryption policy is specified.

getAbsorbConditionalErrorsOnRetry()

Indicates whether a conditional failure should be absorbed on a retry attempt for the request. For more information about absorb conditinal errors on retry defaults, see setAbsorbConditionalErrorsOnRetry(Boolean).

getConcurrentRequestCount()

Gets the concurrent number of simultaneous requests per operation. For more information about concurrent request count defaults, see setConcurrentRequestCount(Integer).

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)

getEncryptionPolicy()

Gets the encryption policy to use for this request. For more information about the encryption policy defaults, see setEncryptionPolicy(BlobEncryptionPolicy).

getSingleBlobPutThresholdInBytes()

Gets the threshold size used for writing a single blob. For more information about the threshold size defaults, see setSingleBlobPutThresholdInBytes(Integer).

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)

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).

getValidateEncryptionPolicy()

Gets a value to indicating whether the presence of the encryption policy should validated.

populateAndApplyDefaults(final BlobRequestOptions options, final BlobType blobType, final CloudBlobClient client)

Uses the concurrent request count from the specified client if , sets a default value for everything else, and sets defaults as defined in the parent class.

populateAndApplyDefaults(final BlobRequestOptions options, final BlobType blobType, final CloudBlobClient client, final boolean setStartTime)

Uses the concurrent request count from the specified client if , sets a default value for everything else, and sets defaults as defined in the parent class.

setAbsorbConditionalErrorsOnRetry(final Boolean absorbConditionalErrorsOnRetry)

Sets whether a conditional failure should be absorbed on a retry attempt for the request. This option is only used by CloudAppendBlob in upload and openWrite methods. By default, it is set to . Set this to only for single writer scenario.

You can change the absorbConditionalErrorsOnRetry value on this request by setting this property. You can also change the value on the CloudBlobClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that absorbConditionalErrorsOnRetry value.

setConcurrentRequestCount(final 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 CloudBlobClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that concurrent request count.

setDisableContentMD5Validation(final 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 . You can change the disableContentMD5Validation value on this request by setting this property. You can also change the value on the CloudBlobClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that disableContentMD5Validation value.

setEncryptionPolicy(BlobEncryptionPolicy encryptionPolicy)

Sets the BlobEncryptionPolicy object to use for this request.

The default BlobEncryptionPolicy is set in the client and is by default null, indicating no encryption. You can change the BlobEncryptionPolicy 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 BlobEncryptionPolicy.

setSingleBlobPutThresholdInBytes(final 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 CloudBlobClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that threshold size.

setStoreBlobContentMD5(final 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 for block blobs. You can change the storeBlobContentMD5 value on this request by setting this property. You can also change the value on the CloudBlobClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that storeBlobContentMD5 value.

setUseTransactionalContentMD5(final 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 . You can change the useTransactionalContentMD5 value on this request by setting this property. You can also change the value on the CloudBlobClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that useTransactionalContentMD5 value.

setValidateEncryptionPolicy(boolean validateEncryptionPolicy)

Sets a value to indicate whether the presence of the encryption policy should validated.