Package 

Interface OTPutParams

  • All Implemented Interfaces:
    org.veupathdb.lib.s3.s34k.params.S3RequestParams

    
    public interface OTPutParams
     implements S3RequestParams
                        

    Object Touch Operation Put Phase Parameters

    Parameters specific to the 'put object' phase of the object touch complex operation.

    If the target object already exists and the ObjectTouchParams.overwrite flag is set to false, these parameters will be ignored.

    • 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 Function0<Unit> getCallback() Optional callback that will be executed on successful completion of the put phase of the touch operation.
      abstract Unit setCallback(Function0<Unit> callback) Optional callback that will be executed on successful completion of the put phase of the touch operation.
      • 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

      • getCallback

         abstract Function0<Unit> getCallback()

        Optional callback that will be executed on successful completion of the put phase of the touch operation.

        If the put phase is skipped on the object touch operation due to an object already existing at the target path and the ObjectTouchParams.overwrite flag being set to false then this callback will not be executed.

      • setCallback

         abstract Unit setCallback(Function0<Unit> callback)

        Optional callback that will be executed on successful completion of the put phase of the touch operation.

        If the put phase is skipped on the object touch operation due to an object already existing at the target path and the ObjectTouchParams.overwrite flag being set to false then this callback will not be executed.