Package 

Interface BucketPutParams

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

    Bucket create request parameters.

    This is a 'complex operation' in that it has 3 phases that can be configured independently:

    • Create the bucket

    • Attach tags to the bucket

    • Get the created bucket

    • 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 MutableTagMap getTags() Tags that may be attached to the target bucket during the execution of this S3 operation.
      abstract Function1<S3Bucket, Unit> getCallback() Optional callback that will be executed on successful completion of the S3 operation.
      abstract Unit setCallback(Function1<S3Bucket, Unit> callback) Optional callback that will be executed on successful completion of the S3 operation.
      abstract BPPutParams getPutParams() Options specific to the put phase of the bucket create operation.
      abstract BPTagPutParams getTagPutParams() Options specific to the tag put phase of the bucket create operation.
      abstract BPGetParams getGetParams() Options specific to the get phase of the bucket create 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.

      • getTags

         abstract MutableTagMap getTags()

        Tags that may be attached to the target bucket during the execution of this S3 operation.

      • getCallback

         abstract Function1<S3Bucket, Unit> getCallback()

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

        This callback will be passed a handle on the newly created S3 bucket.

      • setCallback

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

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

        This callback will be passed a handle on the newly created S3 bucket.

      • getPutParams

         abstract BPPutParams getPutParams()

        Options specific to the put phase of the bucket create operation.

      • getGetParams

         abstract BPGetParams getGetParams()

        Options specific to the get phase of the bucket create operation.