Package alluxio.underfs
Interface AsyncUfsClient
-
- All Known Subinterfaces:
AtomicFileOutputStreamCallback
,UnderFileSystem
- All Known Implementing Classes:
BaseUnderFileSystem
,ConsistentUnderFileSystem
,ManagedBlockingUfsForwarder
,ObjectUnderFileSystem
,UnderFileSystemWithLogging
public interface AsyncUfsClient
The async UFS client interface.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
performListingAsync(java.lang.String path, java.lang.String continuationToken, java.lang.String startAfter, DescendantType descendantType, boolean checkStatus, java.util.function.Consumer<UfsLoadResult> onComplete, java.util.function.Consumer<java.lang.Throwable> onError)
Lists the ufs statuses for a given path.
-
-
-
Method Detail
-
performListingAsync
void performListingAsync(java.lang.String path, @Nullable java.lang.String continuationToken, @Nullable java.lang.String startAfter, DescendantType descendantType, boolean checkStatus, java.util.function.Consumer<UfsLoadResult> onComplete, java.util.function.Consumer<java.lang.Throwable> onError)
Lists the ufs statuses for a given path. TheUfsStatus.getName()
function for the returned values should include the full path of each item from the UFS root (not including the bucket name for object stores). It differs from a traditional listing in that if the input variable checkStatus is true, theUfsStatus
for the base path should be included at the start of the results. The function should return immediately, and perform the operation asynchronously.- Parameters:
path
- the path in ufscontinuationToken
- the continuation tokenstartAfter
- the start after string where the loading starts fromdescendantType
- the load descendant type (NONE/ONE/ALL)checkStatus
- if true the call will perform a GetStatus on the path to see if an object exists, which should be returned as part of the resultonComplete
- the callback when the load is completeonError
- the callback when the load encountered an error
-
-