ReadToFileOptions Class

Package:

com.azure.storage.file.datalake.options

Maven Artifact:

com.azure:azure-storage-file-datalake:12.21.0

• java.lang.Object
• • com.azure.storage.file.datalake.options.ReadToFileOptions

public class ReadToFileOptions

Parameters when calling readToFile() on DataLakeFileClient

Constructor Summary

Constructor	Description
ReadToFileOptions(String filePath)	Constructs a ReadToFileOptions.

Method Summary

Modifier and Type	Method and Description
DataLakeRequestConditions	getDataLakeRequestConditions()
DownloadRetryOptions	getDownloadRetryOptions()
String	getFilePath()
Set<OpenOption>	getOpenOptions()
ParallelTransferOptions	getParallelTransferOptions()
FileRange	getRange()
Boolean	isRangeGetContentMd5()
Boolean	isUserPrincipalName()
ReadToFileOptions	setDataLakeRequestConditions(DataLakeRequestConditions dataLakeRequestConditions)
ReadToFileOptions	setDownloadRetryOptions(DownloadRetryOptions downloadRetryOptions)
ReadToFileOptions	setOpenOptions(Set<OpenOption> openOptions)
ReadToFileOptions	setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions)
ReadToFileOptions	setRange(FileRange range)
ReadToFileOptions	setRangeGetContentMd5(Boolean rangeGetContentMd5)
ReadToFileOptions	setUserPrincipalName(Boolean userPrincipalName)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ReadToFileOptions

public ReadToFileOptions(String filePath)

Constructs a ReadToFileOptions.

Parameters:

filePath - Path of the file to download to.

Method Details

getDataLakeRequestConditions

public DataLakeRequestConditions getDataLakeRequestConditions()

Returns:

requestConditions DataLakeRequestConditions

getDownloadRetryOptions

public DownloadRetryOptions getDownloadRetryOptions()

Returns:

DownloadRetryOptions

getFilePath

public String getFilePath()

Returns:

A String representing the filePath where the downloaded data will be written.

getOpenOptions

public Set getOpenOptions()

Returns:

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

getParallelTransferOptions

public ParallelTransferOptions getParallelTransferOptions()

Returns:

ParallelTransferOptions to use to download to file. Number of parallel transfers parameter is ignored.

getRange

public FileRange getRange()

Returns:

FileRange

isRangeGetContentMd5

public Boolean isRangeGetContentMd5()

Returns:

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

isUserPrincipalName

public Boolean isUserPrincipalName()

Returns:

The value for the x-ms-upn header.

setDataLakeRequestConditions

public ReadToFileOptions setDataLakeRequestConditions(DataLakeRequestConditions dataLakeRequestConditions)

Parameters:

dataLakeRequestConditions - DataLakeRequestConditions

Returns:

The updated options.

setDownloadRetryOptions

public ReadToFileOptions setDownloadRetryOptions(DownloadRetryOptions downloadRetryOptions)

Parameters:

downloadRetryOptions - DownloadRetryOptions

Returns:

The updated options.

setOpenOptions

public ReadToFileOptions setOpenOptions(Set openOptions)

Parameters:

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

Returns:

The updated options.

setParallelTransferOptions

public ReadToFileOptions setParallelTransferOptions(ParallelTransferOptions parallelTransferOptions)

Parameters:

parallelTransferOptions - ParallelTransferOptions to use to download to file. Number of parallel transfers parameter is ignored.

Returns:

The updated options.

setRange

public ReadToFileOptions setRange(FileRange range)

Parameters:

range - FileRange

Returns:

The updated options.

setRangeGetContentMd5

public ReadToFileOptions setRangeGetContentMd5(Boolean rangeGetContentMd5)

Parameters:

rangeGetContentMd5 - Whether the contentMD5 for the specified file range should be returned.

Returns:

The updated options.

setUserPrincipalName

public ReadToFileOptions setUserPrincipalName(Boolean userPrincipalName)

Parameters:

userPrincipalName - The value for the x-ms-upn header.

Returns:

The updated options.