Package 

Interface DirectoryDeleteParams

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

    Directory deletion request parameters.

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

    • List all objects with the target 'directory' prefix

    • Delete only the located objects.

    • 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 Function0<Unit> getCallback() Optional callback that will be executed on successful completion of the S3 operation.
      abstract Unit setCallback(Function0<Unit> callback) Optional callback that will be executed on successful completion of the S3 operation.
      abstract DDListParams getListParams() Parameters specific to the object list phase of the directory delete operation.
      abstract DDDeleteParams getDeleteParams() Parameters specific to the bulk object delete phase of the directory delete 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.

      • getCallback

         abstract Function0<Unit> getCallback()

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

      • setCallback

         abstract Unit setCallback(Function0<Unit> callback)

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

      • getListParams

         abstract DDListParams getListParams()

        Parameters specific to the object list phase of the directory delete operation.

      • getDeleteParams

         abstract DDDeleteParams getDeleteParams()

        Parameters specific to the bulk object delete phase of the directory delete operation.