Package 

Interface FileUploadParams

  • All Implemented Interfaces:
    org.veupathdb.lib.s3.s34k.params.RegionRequestParams , org.veupathdb.lib.s3.s34k.params.S3RequestParams , org.veupathdb.lib.s3.s34k.params.object.ObjectWriteParams 
    
public interface FileUploadParams
 implements ObjectWriteParams

    File upload request parameters.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract File getLocalFile() Required handle on the local file that will be uploaded to the S3 store.
      abstract Unit setLocalFile(File localFile) Required handle on the local file that will be uploaded to the S3 store.
      abstract Integer getPartSize() Max chunk size to send in a single request to the S3 store.
      abstract Unit setPartSize(Integer partSize) Max chunk size to send in a single request to the S3 store.
      abstract String getContentType() Optional content type for the file being uploaded.
      abstract Unit setContentType(String contentType) Optional content type for the file being uploaded.
      abstract Function1<S3Object, Unit> getCallback() Optional callback that will be executed on successful completion of the S3 operation.
      abstract Unit setCallback(Function1<S3Object, Unit> callback) Optional callback that will be executed on successful completion of the S3 operation.

      • Methods inherited from class org.veupathdb.lib.s3.s34k.params.object.ObjectWriteParams

        getTags

      • Methods inherited from class org.veupathdb.lib.s3.s34k.params.RegionRequestParams

        getRegion, setRegion

      • Methods inherited from class org.veupathdb.lib.s3.s34k.params.S3RequestParams

        getHeaders, getQueryParams

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getLocalFile

         abstract File getLocalFile()

        Required handle on the local file that will be uploaded to the S3 store.

        This value must be set or an InvalidRequestConfigError will be thrown when the request is attempted.

      • setLocalFile

         abstract Unit setLocalFile(File localFile)

        Required handle on the local file that will be uploaded to the S3 store.

        This value must be set or an InvalidRequestConfigError will be thrown when the request is attempted.

      • getPartSize

         abstract Integer getPartSize()

        Max chunk size to send in a single request to the S3 store.

        Defaults to 10MiB

      • setPartSize

         abstract Unit setPartSize(Integer partSize)

        Max chunk size to send in a single request to the S3 store.

        Defaults to 10MiB

      • getContentType

         abstract String getContentType()

        Optional content type for the file being uploaded.

      • getCallback

         abstract Function1<S3Object, Unit> getCallback()

        Optional callback that will be executed on successful completion of the S3 operation.

        This callback will be passed an S3Object instance representing the newly created object.

      • setCallback

         abstract Unit setCallback(Function1<S3Object, Unit> callback)

        Optional callback that will be executed on successful completion of the S3 operation.

        This callback will be passed an S3Object instance representing the newly created object.