-
- All Implemented Interfaces:
public interface S3BucketS3 Bucket API Wrapper
Wraps the implementation specific operations on an S3 bucket.
-
-
Method Summary
Modifier and Type Method Description abstract Unitdelete()Deletes this bucket. abstract Unitdelete(Function1<BucketDeleteParams, Unit> action)Deletes this bucket with the operation configured by the given action. abstract Unitdelete(BucketDeleteParams params)Deletes this bucket with the operation configured by the given params. abstract UnitdeleteRecursive()Recursively deletes this bucket and all its contents. abstract UnitdeleteRecursive(Function1<RecursiveBucketDeleteParams, Unit> action)Recursively deletes this bucket and all its contents with the operation configured by the given action. abstract UnitdeleteRecursive(RecursiveBucketDeleteParams params)Recursively deletes this bucket and all its contents with the operation configured by the given params. abstract BucketNamegetName()Name of this bucket. abstract StringgetRegion()Region of this bucket. abstract OffsetDateTimegetCreationDate()Date/time this bucket was created. abstract BucketTagContainergetTags()Bucket tag manager. abstract ObjectContainergetObjects()Bucket object manager -
-
Method Detail
-
delete
abstract Unit delete(Function1<BucketDeleteParams, Unit> action)
Deletes this bucket with the operation configured by the given action.
- Parameters:
action- Action used to configure the S3 operation.
-
delete
abstract Unit delete(BucketDeleteParams params)
Deletes this bucket with the operation configured by the given params.
- Parameters:
params- S3 operation parameters.
-
deleteRecursive
abstract Unit deleteRecursive()
Recursively deletes this bucket and all its contents.
This operation happens in 3 phases which can be configured independently using the RecursiveBucketDeleteParams class. The 3 phases are:
Fetch a list of all the objects in the bucket.
Delete all the objects from the bucket.
Delete the bucket itself.
-
deleteRecursive
abstract Unit deleteRecursive(Function1<RecursiveBucketDeleteParams, Unit> action)
Recursively deletes this bucket and all its contents with the operation configured by the given action.
This operation happens in 3 phases which can be configured independently using the RecursiveBucketDeleteParams class. The 3 phases are:
Fetch a list of all the objects in the bucket.
Delete all the objects from the bucket.
Delete the bucket itself.
- Parameters:
action- Action used to configure the S3 operation.
-
deleteRecursive
abstract Unit deleteRecursive(RecursiveBucketDeleteParams params)
Recursively deletes this bucket and all its contents with the operation configured by the given params.
This operation happens in 3 phases which can be configured independently using the RecursiveBucketDeleteParams class. The 3 phases are:
Fetch a list of all the objects in the bucket.
Delete all the objects from the bucket.
Delete the bucket itself.
- Parameters:
params- S3 operation parameters.
-
getName
abstract BucketName getName()
Name of this bucket.
-
getRegion
abstract String getRegion()
Region of this bucket.
This value will be used as a fallback for operations where no region is configured.
If this value is
nulland a set of operation parameters also has anullregion, no region will be set on the operation.
-
getCreationDate
abstract OffsetDateTime getCreationDate()
Date/time this bucket was created.
-
getTags
abstract BucketTagContainer getTags()
Bucket tag manager.
-
getObjects
abstract ObjectContainer getObjects()
Bucket object manager
-
-
-
-