Package 

Interface ObjectTouchParams

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

    Touch object operation parameters.

    Object touch creates an empty object in the target bucket if no such object already exists. This behavior may be changed using the overwrite flag.

    This is a 'complex operation' in that it may happen in 2 independently configurable phases:

    • Lookup an existing object at the target path.

    • Put a blank object at the target path.

    If overwrite is set to true, phase one is skipped and an object is put into the target bucket no matter what.

    If overwrite is set to false, phase two is skipped if an object already exists in the store at the target path.

    • 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 MutableHeaders getHeaders() Global headers that will be applied to all phases of the operation.
      abstract MutableQueryParams getQueryParams() Global query params that will be applied to all phases of the operation.
      abstract Boolean getOverwrite() Whether a pre-existing object already in the store should be overwritten with a blank file created by this operation.
      abstract Unit setOverwrite(Boolean overwrite) Whether a pre-existing object already in the store should be overwritten with a blank file created by this operation.
      abstract String getContentType() Content type for the object if it is created.
      abstract Unit setContentType(String contentType) Content type for the object if it is created.
      abstract Function1<S3Object, Unit> getCallback() Optional callback that will be executed on successful completion of this S3 operation.
      abstract Unit setCallback(Function1<S3Object, Unit> callback) Optional callback that will be executed on successful completion of this S3 operation.
      abstract OTGetParams getGetParams() Parameters specific to the get phase of the object touch operation.
      abstract OTPutParams getPutParams() Parameters specific to the put phase of the object touch operation.

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

        getRegion, setRegion

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getHeaders

         abstract MutableHeaders getHeaders()

        Global headers that will be applied to all phases of the operation.

        If there is a conflict between a global header and a phase specific header, the phase specific header will be used.

        This is done rather than merging the 2 sets of headers to prevent the creation of invalid headers or otherwise confusing behavior

        If both sets of headers are desired, set the headers on the phase specific header set.

      • getQueryParams

         abstract MutableQueryParams getQueryParams()

        Global query params that will be applied to all phases of the operation.

        If there is a conflict between a global query param and a phase specific query param, the phase specific query param will be used.

        This is done rather than merging the 2 sets of query to prevent possibly confusing behavior.

        If both sets of query params are desired, set the query params on the phase specific query param set.

      • getOverwrite

         abstract Boolean getOverwrite()

        Whether a pre-existing object already in the store should be overwritten with a blank file created by this operation.

        If this is set to true the object get phase of this operation will be skipped.

        Defaults to false

      • setOverwrite

         abstract Unit setOverwrite(Boolean overwrite)

        Whether a pre-existing object already in the store should be overwritten with a blank file created by this operation.

        If this is set to true the object get phase of this operation will be skipped.

        Defaults to false

      • getCallback

         abstract Function1<S3Object, Unit> getCallback()

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

        This callback will be executed after any callbacks set on the parameters for the phases of this operation.

      • setCallback

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

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

        This callback will be executed after any callbacks set on the parameters for the phases of this operation.

      • getGetParams

         abstract OTGetParams getGetParams()

        Parameters specific to the get phase of the object touch operation.

        If overwrite is set to true these parameters will be ignored.

      • getPutParams

         abstract OTPutParams getPutParams()

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

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