org.apache.hadoop.fs.azurebfs.services

Interface ListingSupport

All Known Implementing Classes:

AzureBlobFileSystemStore

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public interface ListingSupport

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.fs.FileStatus[]	listStatus(org.apache.hadoop.fs.Path path)
org.apache.hadoop.fs.FileStatus[]	listStatus(org.apache.hadoop.fs.Path path, String startFrom)
String	listStatus(org.apache.hadoop.fs.Path path, String startFrom, List<org.apache.hadoop.fs.FileStatus> fileStatuses, boolean fetchAll, String continuation)

Method Detail

listStatus

org.apache.hadoop.fs.FileStatus[] listStatus(org.apache.hadoop.fs.Path path)
                                      throws IOException

Parameters:

path - The list path.

Returns:

the entries in the path.

Throws:

IOException - in case of error

listStatus

org.apache.hadoop.fs.FileStatus[] listStatus(org.apache.hadoop.fs.Path path,
                                             String startFrom)
                                      throws IOException

Parameters:

path - Path the list path.

startFrom - The entry name that list results should start with. For example, if folder "/folder" contains four files: "afile", "bfile", "hfile", "ifile". Then listStatus(Path("/folder"), "hfile") will return "/folder/hfile" and "folder/ifile" Notice that if startFrom is a non-existent entry name, then the list response contains all entries after this non-existent entry in lexical order: listStatus (Path("/folder"), "cfile") will return "/folder/hfile" and "/folder/ifile".

Returns:

the entries in the path start from "startFrom" in lexical order.

Throws:

IOException - in case of error

listStatus

String listStatus(org.apache.hadoop.fs.Path path,
                  String startFrom,
                  List<org.apache.hadoop.fs.FileStatus> fileStatuses,
                  boolean fetchAll,
                  String continuation)
           throws IOException

Parameters:

path - The list path

startFrom - The entry name that list results should start with. For example, if folder "/folder" contains four files: "afile", "bfile", "hfile", "ifile". Then listStatus(Path("/folder"), "hfile") will return "/folder/hfile" and "folder/ifile" Notice that if startFrom is a non-existent entry name, then the list response contains all entries after this non-existent entry in lexical order: listStatus (Path("/folder"), "cfile") will return "/folder/hfile" and "/folder/ifile".

fileStatuses - This list has to be filled with the FileStatus objects

fetchAll - flag to indicate if the above list needs to be filled with just one page os results or the entire result.

continuation - Contiuation token. null means start rom the begining.

Returns:

Continuation tokem

Throws:

IOException - in case of error