RecursiveBucketDeleteParams 0.8.0 API

All Implemented Interfaces:

org.veupathdb.lib.s3.s34k.params.RegionRequestParams , org.veupathdb.lib.s3.s34k.params.S3RequestParams
```
public interface RecursiveBucketDeleteParams
 implements RegionRequestParams
                    
```
Recursive Bucket Delete Request Parameters.
Defines request parameters used in the multi-stage operation necessary to fully remove a bucket from an S3 instance.
This operation happens in 3 stages:
- Fetch a listing of all objects in the bucket.
- Recursively delete all objects in the bucket.
- Delete the bucket itself.
Each phase can be configured independently with headers and query parameters, in addition to sets of global (all phase) headers and query parameters.
As this operation is complex, there is are a lot of errors that could result from the operation, and those errors will include as much information as possible to assist in recovering or handling each error.

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()`	Headers that will be applied to all requests in all phases of the recursive bucket delete operation.
`abstract MutableQueryParams`	`getQueryParams()`	Query parameters that will be applied to all requests in all phases of the recursive bucket delete operation.
`abstract String`	`getRegion()`	Global region value that will be applied to all requests in all phases of the recursive bucket delete operation.
`abstract Unit`	`setRegion(String region)`	Global region value that will be applied to all requests in all phases of the recursive bucket delete operation.
`abstract RBDObjectListParams`	`getObjectFetch()`	Object list operation parameters.
`abstract RBDObjectDeleteParams`	`getObjectDelete()`	Bulk object delete operation parameters.
`abstract RBDBucketDeleteParams`	`getBucketDelete()`	Bucket delete operation parameters.
`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.

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()
```
    Headers that will be applied to all requests in all phases of the recursive bucket delete operation.
  - getQueryParams
```
 abstract MutableQueryParams getQueryParams()
```
    Query parameters that will be applied to all requests in all phases of the recursive bucket delete operation.
  - getRegion
```
 abstract String getRegion()
```
    Global region value that will be applied to all requests in all phases of the recursive bucket delete operation.
  - setRegion
```
 abstract Unit setRegion(String region)
```
    Global region value that will be applied to all requests in all phases of the recursive bucket delete operation.
  - getObjectFetch
```
 abstract RBDObjectListParams getObjectFetch()
```
    Object list operation parameters.
  - getObjectDelete
```
 abstract RBDObjectDeleteParams getObjectDelete()
```
    Bulk object delete operation parameters.
  - getBucketDelete
```
 abstract RBDBucketDeleteParams getBucketDelete()
```
    Bucket delete operation parameters.
  - 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.