s34k/org.veupathdb.lib.s3.s34k.params.bucket.recursive/RecursiveBucketDeleteParams

RecursiveBucketDeleteParams

interface RecursiveBucketDeleteParams : 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.

Author

Elizabeth Paige Harper https://github.com/Foxcapades

Since

v0.1.0

Properties

bucketDelete

abstract val bucketDelete: RBDBucketDeleteParams

Bucket delete operation parameters.

callback

abstract var callback: () -> Unit?

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

headers

abstract override val headers: MutableHeaders

Headers that will be applied to all requests in all phases of the recursive bucket delete operation.

objectDelete

abstract val objectDelete: RBDObjectDeleteParams

Bulk object delete operation parameters.

objectFetch

abstract val objectFetch: RBDObjectListParams

Object list operation parameters.

queryParams

abstract override val queryParams: MutableQueryParams

Query parameters that will be applied to all requests in all phases of the recursive bucket delete operation.

region

abstract override var region: String?

Global region value that will be applied to all requests in all phases of the recursive bucket delete operation.