BatchListingOperations (Apache Hadoop Common 3.5.0 API)
Description: declaration: package: org.apache.hadoop.fs, interface: BatchListingOperations

Package org.apache.hadoop.fs

# Interface BatchListingOperations

@Public @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
  Description
  `RemoteIterator<PartialListing<LocatedFileStatus>>`
  `batchedListLocatedStatusIterator(List<Path> paths)`
  Batched listing API that returns `PartialListing`s for the passed Paths.
  `RemoteIterator<PartialListing<FileStatus>>`
  `batchedListStatusIterator(List<Path> paths)`
  Batched listing API that returns `PartialListing`s for the passed Paths.

- ## Method Details

  - ### batchedListStatusIterator

    RemoteIterator<PartialListing<FileStatus>> batchedListStatusIterator(List<Path> paths) throws IOException
    Batched listing API that returns `PartialListing`s 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 `PartialListing`s 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