Package com.azure.storage.file.share.options

Class ShareFileDownloadOptions

java.lang.Object

com.azure.storage.file.share.options.ShareFileDownloadOptions

public final class ShareFileDownloadOptions
extends Object

Extended options that may be passed when downloading a File.

Constructor Summary

Constructors

Constructor	Description
ShareFileDownloadOptions()	Creates a new instance of ShareFileDownloadOptions.

Method Summary

Modifier and Type	Method	Description
ShareFileRange	getRange()	Gets the range of bytes over which to list ranges, inclusively.
ShareRequestConditions	getRequestConditions()	Gets the ShareRequestConditions.
DownloadRetryOptions	getRetryOptions()	Gets the DownloadRetryOptions.
Boolean	isRangeContentMd5Requested()	Gets whether the service returns the MD5 hash for the range.
ShareFileDownloadOptions	setRange(ShareFileRange range)	Sets the range of bytes over which to list ranges, inclusively.
ShareFileDownloadOptions	setRangeContentMd5Requested(Boolean rangeContentMd5Requested)	Sets whether the service returns the MD5 hash for the range.
ShareFileDownloadOptions	setRequestConditions(ShareRequestConditions requestConditions)	Sets the ShareRequestConditions for the file.
ShareFileDownloadOptions	setRetryOptions(DownloadRetryOptions retryOptions)	Sets the DownloadRetryOptions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShareFileDownloadOptions

public ShareFileDownloadOptions()

Creates a new instance of ShareFileDownloadOptions.

Method Details

getRange

public ShareFileRange getRange()

Gets the range of bytes over which to list ranges, inclusively.

Returns:

The range of bytes over which to list ranges, inclusively.

setRange

public ShareFileDownloadOptions setRange(ShareFileRange range)

Sets the range of bytes over which to list ranges, inclusively.

Parameters:

range - The range of bytes over which to list ranges, inclusively.

Returns:

The updated options.

isRangeContentMd5Requested

public Boolean isRangeContentMd5Requested()

Gets whether the service returns the MD5 hash for the range.

Returns:

Whether the service returns the MD5 hash for the range.

setRangeContentMd5Requested

public ShareFileDownloadOptions setRangeContentMd5Requested(Boolean rangeContentMd5Requested)

Sets whether the service returns the MD5 hash for the range.

Parameters:

rangeContentMd5Requested - Whether the service returns the MD5 hash for the range.

Returns:

The updated options.

getRequestConditions

public ShareRequestConditions getRequestConditions()

Gets the ShareRequestConditions.

Returns:

ShareRequestConditions

setRequestConditions

public ShareFileDownloadOptions setRequestConditions(ShareRequestConditions requestConditions)

Sets the ShareRequestConditions for the file.

Parameters:

requestConditions - ShareRequestConditions for the file.

Returns:

The updated options.

getRetryOptions

public DownloadRetryOptions getRetryOptions()

Gets the DownloadRetryOptions.

Returns:

DownloadRetryOptions

setRetryOptions

public ShareFileDownloadOptions setRetryOptions(DownloadRetryOptions retryOptions)

Sets the DownloadRetryOptions.

Parameters:

retryOptions - DownloadRetryOptions

Returns:

The updated options.