org.apache.hadoop.fs

Interface BatchListingOperations

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public interface BatchListingOperations

Interface filesystems MAY implement to offer a batched list. If implemented, filesystems SHOULD declare CommonPathCapabilities.FS_EXPERIMENTAL_BATCH_LISTING to be a supported path capability.

Method Summary

Modifier and Type	Method and Description
RemoteIterator<PartialListing<LocatedFileStatus>>	batchedListLocatedStatusIterator(List<Path> paths) Batched listing API that returns PartialListings for the passed Paths.
RemoteIterator<PartialListing<FileStatus>>	batchedListStatusIterator(List<Path> paths) Batched listing API that returns PartialListings for the passed Paths.

Method Detail

batchedListStatusIterator

RemoteIterator<PartialListing<FileStatus>> batchedListStatusIterator(List<Path> paths)
                                                              throws IOException

Batched listing API that returns PartialListings for the passed Paths.

Parameters:

paths - List of paths to list.

Returns:

RemoteIterator that returns corresponding PartialListings.

Throws:

IOException - failure

batchedListLocatedStatusIterator

RemoteIterator<PartialListing<LocatedFileStatus>> batchedListLocatedStatusIterator(List<Path> paths)
                                                                            throws IOException

Batched listing API that returns PartialListings for the passed Paths. The PartialListing will contain LocatedFileStatus entries with locations.

Parameters:

paths - List of paths to list.

Returns:

RemoteIterator that returns corresponding PartialListings.

Throws:

IOException - failure