Package com.azure.storage.blob.options

Class BlobDownloadToFileOptions

java.lang.Object

com.azure.storage.blob.options.BlobDownloadToFileOptions

public class BlobDownloadToFileOptions
extends Object

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

Constructor Summary

Constructors

Constructor	Description
BlobDownloadToFileOptions(String filePath)	Constructs a BlobDownloadToFileOptions.

Method Summary

Modifier and Type	Method	Description
DownloadRetryOptions	getDownloadRetryOptions()	Gets the DownloadRetryOptions.
String	getFilePath()	Gets the path of the file to download to.
Set<OpenOption>	getOpenOptions()	Gets the OpenOptions to use to configure how to open or create the file.
ParallelTransferOptions	getParallelTransferOptions()	Gets the ParallelTransferOptions.
BlobRange	getRange()	Gets the BlobRange.
BlobRequestConditions	getRequestConditions()	Gets the BlobRequestConditions.
boolean	isRetrieveContentRangeMd5()	Gets whether the contentMD5 for the specified blob range should be returned.
BlobDownloadToFileOptions	setDownloadRetryOptions(DownloadRetryOptions downloadRetryOptions)	Sets the DownloadRetryOptions.
BlobDownloadToFileOptions	setOpenOptions(Set<OpenOption> openOptions)	Sets the OpenOptions to use to configure how to open or create the file.
BlobDownloadToFileOptions	setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions)	Sets the ParallelTransferOptions.
BlobDownloadToFileOptions	setRange(BlobRange range)	Sets the BlobRange.
BlobDownloadToFileOptions	setRequestConditions(BlobRequestConditions requestConditions)	Sets the BlobRequestConditions.
BlobDownloadToFileOptions	setRetrieveContentRangeMd5(boolean retrieveContentRangeMd5)	Sets whether the contentMD5 for the specified blob range should be returned.

Methods inherited from class 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.

Throws:

NullPointerException - If filePath is null.

Method Details

getFilePath

public String getFilePath()

Gets the path of the file to download to.

Returns:

The path of the file to download to.

getRange

public BlobRange getRange()

Gets the BlobRange.

Returns:

BlobRange

getParallelTransferOptions

public ParallelTransferOptions getParallelTransferOptions()

Gets the ParallelTransferOptions.

Returns:

ParallelTransferOptions

getDownloadRetryOptions

public DownloadRetryOptions getDownloadRetryOptions()

Gets the DownloadRetryOptions.

Returns:

DownloadRetryOptions

getRequestConditions

public BlobRequestConditions getRequestConditions()

Gets the BlobRequestConditions.

Returns:

BlobRequestConditions

isRetrieveContentRangeMd5

public boolean isRetrieveContentRangeMd5()

Gets whether the contentMD5 for the specified blob range should be returned.

Returns:

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

getOpenOptions

public Set<OpenOption> getOpenOptions()

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

Returns:

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

setRange

public BlobDownloadToFileOptions setRange(BlobRange range)

Sets the BlobRange.

Parameters:

range - BlobRange

Returns:

The updated options.

setParallelTransferOptions

public BlobDownloadToFileOptions setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions)

Sets the ParallelTransferOptions.

Parameters:

parallelTransferOptions - ParallelTransferOptions

Returns:

The updated options.

setDownloadRetryOptions

public BlobDownloadToFileOptions setDownloadRetryOptions(DownloadRetryOptions downloadRetryOptions)

Sets the DownloadRetryOptions.

Parameters:

downloadRetryOptions - DownloadRetryOptions

Returns:

The updated options.

setRequestConditions

public BlobDownloadToFileOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the BlobRequestConditions.

Parameters:

requestConditions - BlobRequestConditions

Returns:

The updated options.

setRetrieveContentRangeMd5

public BlobDownloadToFileOptions setRetrieveContentRangeMd5(boolean retrieveContentRangeMd5)

Sets whether the contentMD5 for the specified blob range should be returned.

Parameters:

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

Returns:

The updated options.

setOpenOptions

public BlobDownloadToFileOptions setOpenOptions(Set<OpenOption> openOptions)

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

Parameters:

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

Returns:

The updated options.