Interface DownloadFileRequest.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DownloadFileRequest.Builder,DownloadFileRequest>, SdkBuilder<DownloadFileRequest.Builder,DownloadFileRequest>
Enclosing class:
DownloadFileRequest
@NotThreadSafe public static interface DownloadFileRequest.Builder extends CopyableBuilder<DownloadFileRequest.Builder,DownloadFileRequest>
A builder for a DownloadFileRequest, created with DownloadFileRequest.builder()

  • Method Details

    • destination

      DownloadFileRequest.Builder destination(Path destination)
      The Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown.
      Parameters:
      destination - the destination path
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      default DownloadFileRequest.Builder destination(File destination)
      The file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown.
      Parameters:
      destination - the destination path
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getObjectRequest

      DownloadFileRequest.Builder getObjectRequest(GetObjectRequest getObjectRequest)
      The GetObjectRequest request that should be used for the download
      Parameters:
      getObjectRequest - the getObject request
      Returns:
      a reference to this object so that method calls can be chained together.
      See Also:

    • getObjectRequest

      default DownloadFileRequest.Builder getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder)
      The GetObjectRequest request that should be used for the download

      This is a convenience method that creates an instance of the GetObjectRequest builder avoiding the need to create one manually via GetObjectRequest.builder().

      Parameters:
      getObjectRequestBuilder - the getObject request
      Returns:
      a reference to this object so that method calls can be chained together.
      See Also:

    • transferListeners

      DownloadFileRequest.Builder transferListeners(Collection<TransferListener> transferListeners)
      The TransferListeners that will be notified as part of this request. This method overrides and replaces any transferListeners that have already been set. Add an optional request override configuration.
      Parameters:
      transferListeners - the collection of transferListeners
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • addTransferListener

      DownloadFileRequest.Builder addTransferListener(TransferListener transferListener)
      Add a TransferListener that will be notified as part of this request.
      Parameters:
      transferListener - the transferListener to add
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: