org.apache.hadoop.fs.s3a.tools

Interface MarkerToolOperations

All Known Implementing Classes:

MarkerToolOperationsImpl

public interface MarkerToolOperations

Operations which must be offered by the store for MarkerTool. These are a proper subset of OperationCallbacks; this interface strips down those provided to the tool.

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.fs.RemoteIterator<S3AFileStatus>	listObjects(org.apache.hadoop.fs.Path path, String key) Create an iterator over objects in S3.
void	removeKeys(List<software.amazon.awssdk.services.s3.model.ObjectIdentifier> keysToDelete, boolean deleteFakeDir) Remove keys from the store.

Method Detail

listObjects

@Retries.RetryTranslated
org.apache.hadoop.fs.RemoteIterator<S3AFileStatus> listObjects(org.apache.hadoop.fs.Path path,
                                                                                        String key)
                                                                                 throws IOException

Create an iterator over objects in S3. The listing includes the key itself, if found.

Parameters:

path - path of the listing.

key - object key

Returns:

iterator with the first listing completed.

Throws:

IOException - failure.

removeKeys

@Retries.RetryMixed
void removeKeys(List<software.amazon.awssdk.services.s3.model.ObjectIdentifier> keysToDelete,
                                    boolean deleteFakeDir)
                             throws MultiObjectDeleteException,
                                    software.amazon.awssdk.awscore.exception.AwsServiceException,
                                    IOException

Remove keys from the store.

Parameters:

keysToDelete - collection of keys to delete on the s3-backend. if empty, no request is made of the object store.

deleteFakeDir - indicates whether this is for deleting fake dirs. all deleted keys

Throws:

org.apache.hadoop.fs.InvalidRequestException - if the request was rejected due to a mistaken attempt to delete the root directory.

MultiObjectDeleteException - one or more of the keys could not be deleted in a multiple object delete operation.

software.amazon.awssdk.awscore.exception.AwsServiceException - amazon-layer failure.

IOException - other IO Exception.