BlobDownloadToFileOptions Class

Package:

com.azure.storage.blob.options

Maven Artifact:

com.azure:azure-storage-blob:12.28.1

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

public class BlobDownloadToFileOptions

Extended options that may be passed when downloading a blob to a file.

Constructor Summary

Constructor	Description
BlobDownloadToFileOptions(String filePath)	Constructs a BlobDownloadToFileOptions.

Method Summary

Modifier and Type	Method and Description
DownloadRetryOptions	getDownloadRetryOptions()
String	getFilePath()
Set<OpenOption>	getOpenOptions()
ParallelTransferOptions	getParallelTransferOptions()
BlobRange	getRange()
BlobRequestConditions	getRequestConditions()
boolean	isRetrieveContentRangeMd5()
BlobDownloadToFileOptions	setDownloadRetryOptions(DownloadRetryOptions downloadRetryOptions)
BlobDownloadToFileOptions	setOpenOptions(Set<OpenOption> openOptions)
BlobDownloadToFileOptions	setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions)
BlobDownloadToFileOptions	setRange(BlobRange range)
BlobDownloadToFileOptions	setRequestConditions(BlobRequestConditions requestConditions)
BlobDownloadToFileOptions	setRetrieveContentRangeMd5(boolean retrieveContentRangeMd5)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobDownloadToFileOptions

public BlobDownloadToFileOptions(String filePath)

Constructs a BlobDownloadToFileOptions.

Parameters:

filePath - Path of the file to download to.

Method Details

getDownloadRetryOptions

public DownloadRetryOptions getDownloadRetryOptions()

Returns:

DownloadRetryOptions

getFilePath

public String getFilePath()

Returns:

The path of the file to download to.

getOpenOptions

public Set getOpenOptions()

Returns:

OpenOptions to use to configure how to open or create the file.

getParallelTransferOptions

public ParallelTransferOptions getParallelTransferOptions()

Returns:

ParallelTransferOptions

getRange

public BlobRange getRange()

Returns:

BlobRange

getRequestConditions

public BlobRequestConditions getRequestConditions()

Returns:

BlobRequestConditions

isRetrieveContentRangeMd5

public boolean isRetrieveContentRangeMd5()

Returns:

Whether the contentMD5 for the specified blob range should be returned.

setDownloadRetryOptions

public BlobDownloadToFileOptions setDownloadRetryOptions(DownloadRetryOptions downloadRetryOptions)

Parameters:

downloadRetryOptions - DownloadRetryOptions

Returns:

The updated options.

setOpenOptions

public BlobDownloadToFileOptions setOpenOptions(Set openOptions)

Parameters:

openOptions - OpenOptions to use to configure how to open or create the file.

Returns:

The updated options.

setParallelTransferOptions

public BlobDownloadToFileOptions setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions)

Parameters:

parallelTransferOptions - ParallelTransferOptions

Returns:

The updated options.

setRange

public BlobDownloadToFileOptions setRange(BlobRange range)

Parameters:

range - BlobRange

Returns:

The updated options.

setRequestConditions

public BlobDownloadToFileOptions setRequestConditions(BlobRequestConditions requestConditions)

Parameters:

requestConditions - BlobRequestConditions

Returns:

The updated options.

setRetrieveContentRangeMd5

public BlobDownloadToFileOptions setRetrieveContentRangeMd5(boolean retrieveContentRangeMd5)

Parameters:

retrieveContentRangeMd5 - Whether the contentMD5 for the specified blob range should be returned.

Returns:

The updated options.