Package software.amazon.awssdk.core

Interface FileRequestBodyConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FileRequestBodyConfiguration.Builder,FileRequestBodyConfiguration>, SdkBuilder<FileRequestBodyConfiguration.Builder,FileRequestBodyConfiguration>
Enclosing class:
FileRequestBodyConfiguration
public static interface FileRequestBodyConfiguration.Builder extends CopyableBuilder<FileRequestBodyConfiguration.Builder,FileRequestBodyConfiguration>

  • Method Details

    • path

      FileRequestBodyConfiguration.Builder path(Path path)
      Sets the Path to the file containing data to send to the service
      Parameters:
      path - Path to file to read.
      Returns:
      This builder for method chaining.

    • chunkSizeInBytes

      FileRequestBodyConfiguration.Builder chunkSizeInBytes(Integer chunkSize)
      Sets the size of chunks read from the file. Increasing this will cause more data to be buffered into memory but may yield better latencies. Decreasing this will reduce memory usage but may cause reduced latency. Setting this value is very dependent on upload speed and requires some performance testing to tune.

      The default chunk size is 16 KiB

      Parameters:
      chunkSize - New chunk size in bytes.
      Returns:
      This builder for method chaining.

    • position

      FileRequestBodyConfiguration.Builder position(Long position)
      Sets the file position at which the request body begins.

      By default, it's 0, i.e., reading from the beginning.

      Parameters:
      position - the position of the file
      Returns:
      The builder for method chaining.

    • numBytesToRead

      FileRequestBodyConfiguration.Builder numBytesToRead(Long numBytesToRead)
      Sets the number of bytes to read from this file.

      By default, it's same as the file length.

      Parameters:
      numBytesToRead - number of bytes to read
      Returns:
      The builder for method chaining.