Package org.apache.hadoop.fs.azurebfs.services

Interface ListingSupport

All Known Implementing Classes:

AzureBlobFileSystemStore

@Private
@Unstable
public interface ListingSupport

Method Summary

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

Method Detail

listStatus

org.apache.hadoop.fs.FileStatus[] listStatus(org.apache.hadoop.fs.Path path,
                                             TracingContext tracingContext)
                                      throws java.io.IOException

Parameters:

path - The list path.

tracingContext - TracingContext instance to track identifiers

Returns:

the entries in the path.

Throws:

java.io.IOException - in case of error

listStatus

org.apache.hadoop.fs.FileStatus[] listStatus(org.apache.hadoop.fs.Path path,
                                             java.lang.String startFrom,
                                             TracingContext tracingContext)
                                      throws java.io.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".

tracingContext - TracingContext instance to track identifiers

Returns:

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

Throws:

java.io.IOException - in case of error

listStatus

java.lang.String listStatus(org.apache.hadoop.fs.Path path,
                            java.lang.String startFrom,
                            java.util.List<org.apache.hadoop.fs.FileStatus> fileStatuses,
                            boolean fetchAll,
                            java.lang.String continuation,
                            TracingContext tracingContext)
                     throws java.io.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.

tracingContext - TracingContext instance to track identifiers

Returns:

Continuation tokem

Throws:

java.io.IOException - in case of error