BlobDownloadStreamOptions Class

  • java.lang.Object
    • com.azure.storage.blob.options.BlobDownloadStreamOptions

public final class BlobDownloadStreamOptions

Extended options that may be passed when downloading a blob range to an output stream.

Constructor Summary

Constructor Description
BlobDownloadStreamOptions()

Creates a new instance of BlobDownloadStreamOptions.

Method Summary

Modifier and Type Method and Description
ContentValidationAlgorithm getContentValidationAlgorithm()

Gets the algorithm to use for transfer content validation on the response.

DownloadRetryOptions getDownloadRetryOptions()

Gets the DownloadRetryOptions.

BlobRange getRange()

Gets the BlobRange.

BlobRequestConditions getRequestConditions()

Gets the BlobRequestConditions.

boolean isRetrieveContentRangeMd5()

Gets whether the content MD5 for the specified blob range should be returned.

BlobDownloadStreamOptions setContentValidationAlgorithm(ContentValidationAlgorithm contentValidationAlgorithm)

Sets the algorithm to use for transfer content validation on the response.

BlobDownloadStreamOptions setDownloadRetryOptions(DownloadRetryOptions downloadRetryOptions)

Sets the DownloadRetryOptions.

BlobDownloadStreamOptions setRange(BlobRange range)

Sets the BlobRange.

BlobDownloadStreamOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the BlobRequestConditions.

BlobDownloadStreamOptions setRetrieveContentRangeMd5(boolean retrieveContentRangeMd5)

Sets whether the content MD5 for the specified blob range should be returned.

Methods inherited from java.lang.Object

Constructor Details

BlobDownloadStreamOptions

public BlobDownloadStreamOptions()

Creates a new instance of BlobDownloadStreamOptions.

Method Details

getContentValidationAlgorithm

public ContentValidationAlgorithm getContentValidationAlgorithm()

Gets the algorithm to use for transfer content validation on the response. See ContentValidationAlgorithm for more details.

Returns:

The transfer validation checksum algorithm.

getDownloadRetryOptions

public DownloadRetryOptions getDownloadRetryOptions()

Gets the DownloadRetryOptions.

Returns:

The download retry options.

getRange

public BlobRange getRange()

Gets the BlobRange.

Returns:

The blob range.

getRequestConditions

public BlobRequestConditions getRequestConditions()

Gets the BlobRequestConditions.

Returns:

The request conditions.

isRetrieveContentRangeMd5

public boolean isRetrieveContentRangeMd5()

Gets whether the content MD5 for the specified blob range should be returned.

Returns:

Whether to retrieve content range MD5.

setContentValidationAlgorithm

public BlobDownloadStreamOptions setContentValidationAlgorithm(ContentValidationAlgorithm contentValidationAlgorithm)

Sets the algorithm to use for transfer content validation on the response. See ContentValidationAlgorithm for more details.

Parameters:

contentValidationAlgorithm - The transfer validation checksum algorithm.

Returns:

The updated options.

setDownloadRetryOptions

public BlobDownloadStreamOptions setDownloadRetryOptions(DownloadRetryOptions downloadRetryOptions)

Sets the DownloadRetryOptions.

Parameters:

downloadRetryOptions - The download retry options.

Returns:

The updated options.

setRange

public BlobDownloadStreamOptions setRange(BlobRange range)

Sets the BlobRange.

Parameters:

range - The blob range.

Returns:

The updated options.

setRequestConditions

public BlobDownloadStreamOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the BlobRequestConditions.

Parameters:

requestConditions - The request conditions.

Returns:

The updated options.

setRetrieveContentRangeMd5

public BlobDownloadStreamOptions setRetrieveContentRangeMd5(boolean retrieveContentRangeMd5)

Sets whether the content MD5 for the specified blob range should be returned.

Parameters:

retrieveContentRangeMd5 - Whether to retrieve content range MD5.

Returns:

The updated options.

Applies to