alluxio.underfs

Interface AsyncUfsClient

All Known Subinterfaces:

AtomicFileOutputStreamCallback, UnderFileSystem

All Known Implementing Classes:

AbfsUnderFileSystem, AdlUnderFileSystem, BaseUnderFileSystem, CephfsHadoopUnderFileSystem, CephFSUnderFileSystem, ConsistentUnderFileSystem, CosnUnderFileSystem, COSUnderFileSystem, GCSUnderFileSystem, GCSV2UnderFileSystem, HdfsUnderFileSystem, LocalUnderFileSystem, ManagedBlockingUfsForwarder, ObjectUnderFileSystem, OBSUnderFileSystem, OSSUnderFileSystem, OzoneUnderFileSystem, S3AUnderFileSystem, UnderFileSystemWithLogging, WasbUnderFileSystem

public interface AsyncUfsClient

The async UFS client interface.

Method Summary

Modifier and Type	Method and Description
void	performListingAsync(String path, String continuationToken, String startAfter, DescendantType descendantType, boolean checkStatus, java.util.function.Consumer<UfsLoadResult> onComplete, java.util.function.Consumer<Throwable> onError) Lists the ufs statuses for a given path.

Method Detail

performListingAsync

void performListingAsync(String path,
                         @Nullable
                         String continuationToken,
                         @Nullable
                         String startAfter,
                         DescendantType descendantType,
                         boolean checkStatus,
                         java.util.function.Consumer<UfsLoadResult> onComplete,
                         java.util.function.Consumer<Throwable> onError)

Lists the ufs statuses for a given path. The UfsStatus.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, the UfsStatus 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 ufs

continuationToken - the continuation token

startAfter - the start after string where the loading starts from

descendantType - 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 result

onComplete - the callback when the load is complete

onError - the callback when the load encountered an error