Package com.azure.storage.file.datalake.options

Class ReadToFileOptions

java.lang.Object
com.azure.storage.file.datalake.options.ReadToFileOptions
public class ReadToFileOptions extends Object
Parameters when calling readToFile() on DataLakeFileClient

  • Constructor Details

    • ReadToFileOptions

      public ReadToFileOptions(String filePath)
      Constructs a ReadToFileOptions.
      Parameters:
      filePath - Path of the file to download to.

  • Method Details

    • getFilePath

      public String getFilePath()
      Returns:
      A String representing the filePath where the downloaded data will be written.

    • getRange

      public FileRange getRange()
      Returns:
      FileRange

    • setRange

      public ReadToFileOptions setRange(FileRange range)
      Parameters:
      range - FileRange
      Returns:
      The updated options.

    • getParallelTransferOptions

      public com.azure.storage.common.ParallelTransferOptions getParallelTransferOptions()
      Returns:
      ParallelTransferOptions to use to download to file. Number of parallel transfers parameter is ignored.

    • setParallelTransferOptions

      public ReadToFileOptions setParallelTransferOptions(com.azure.storage.common.ParallelTransferOptions parallelTransferOptions)
      Parameters:
      parallelTransferOptions - ParallelTransferOptions to use to download to file. Number of parallel transfers parameter is ignored.
      Returns:
      The updated options.

    • getDownloadRetryOptions

      public DownloadRetryOptions getDownloadRetryOptions()
      Returns:
      DownloadRetryOptions

    • setDownloadRetryOptions

      public ReadToFileOptions setDownloadRetryOptions(DownloadRetryOptions downloadRetryOptions)
      Parameters:
      downloadRetryOptions - DownloadRetryOptions
      Returns:
      The updated options.

    • getDataLakeRequestConditions

      public DataLakeRequestConditions getDataLakeRequestConditions()
      Returns:
      requestConditions DataLakeRequestConditions

    • setDataLakeRequestConditions

      public ReadToFileOptions setDataLakeRequestConditions(DataLakeRequestConditions dataLakeRequestConditions)
      Parameters:
      dataLakeRequestConditions - DataLakeRequestConditions
      Returns:
      The updated options.
      Throws:
      UncheckedIOException - If an I/O error occurs.

    • isRangeGetContentMd5

      public Boolean isRangeGetContentMd5()
      Returns:
      Whether the contentMD5 for the specified file range should be returned.

    • setRangeGetContentMd5

      public ReadToFileOptions setRangeGetContentMd5(Boolean rangeGetContentMd5)
      Parameters:
      rangeGetContentMd5 - Whether the contentMD5 for the specified file range should be returned.
      Returns:
      The updated options.

    • getOpenOptions

      public Set<OpenOption> getOpenOptions()
      Returns:
      OpenOptions to use to configure how to open or create the file.

    • setOpenOptions

      public ReadToFileOptions setOpenOptions(Set<OpenOption> openOptions)
      Parameters:
      openOptions - OpenOptions to use to configure how to open or create the file.
      Returns:
      The updated options.

    • isUserPrincipalName

      public Boolean isUserPrincipalName()
      Returns:
      The value for the x-ms-upn header.

    • setUserPrincipalName

      public ReadToFileOptions setUserPrincipalName(Boolean userPrincipalName)
      Parameters:
      userPrincipalName - The value for the x-ms-upn header.
      Returns:
      The updated options.