org.apache.hadoop.fs

Interface BulkDeleteSource

All Known Implementing Classes:

AdlFileSystem, ChecksumFileSystem, FileSystem, FilterFileSystem, FTPFileSystem, LocalFileSystem, NativeAzureFileSystem, NativeS3FileSystem, RawLocalFileSystem, ViewFileSystem

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public interface BulkDeleteSource

Interface for bulk deletion. Filesystems which support bulk deletion should implement this interface and MUST also declare their support in the path capability CommonPathCapabilities.BULK_DELETE. Exporting the interface does not guarantee that the operation is supported; returning a BulkDelete object from the call createBulkDelete(Path) is.

Method Summary

Modifier and Type	Method and Description
BulkDelete	createBulkDelete(Path path) Create a bulk delete operation.

Method Detail

createBulkDelete

BulkDelete createBulkDelete(Path path)
                     throws UnsupportedOperationException,
                            IllegalArgumentException,
                            IOException

Create a bulk delete operation. There is no network IO at this point, simply the creation of a bulk delete object. A path must be supplied to assist in link resolution.

Parameters:

path - path to delete under.

Returns:

the bulk delete.

Throws:

UnsupportedOperationException - bulk delete under that path is not supported.

IllegalArgumentException - path not valid.

IOException - problems resolving paths