Class BlobDownloadToFileOptions

java.lang.Object
com.azure.storage.blob.options.BlobDownloadToFileOptions
All Implemented Interfaces:
com.azure.storage.common.ValidatableContent
public class BlobDownloadToFileOptions extends Object implements com.azure.storage.common.ValidatableContent
Extended options that may be passed when downloading a blob to a file.

  • Constructor Details

  • 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 com.azure.storage.common.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(com.azure.storage.common.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.

    • getContentValidationAlgorithm

      public com.azure.storage.common.ContentValidationAlgorithm getContentValidationAlgorithm()
      Gets the algorithm to use for transfer content validation on the response. See ContentValidationAlgorithm for more details.
      Specified by:
      getContentValidationAlgorithm in interface com.azure.storage.common.ValidatableContent
      Returns:
      The transfer validation checksum algorithm.

    • setContentValidationAlgorithm

      public BlobDownloadToFileOptions setContentValidationAlgorithm(com.azure.storage.common.ContentValidationAlgorithm contentValidationAlgorithm)
      Sets the algorithm to use for transfer content validation on the response. See ContentValidationAlgorithm for more details.
      Specified by:
      setContentValidationAlgorithm in interface com.azure.storage.common.ValidatableContent
      Parameters:
      contentValidationAlgorithm - The transfer validation checksum algorithm.
      Returns:
      The updated options.