alluxio.client.file

Interface FileSystemMasterClient

All Superinterfaces:

AutoCloseable, Client, Closeable

All Known Implementing Classes:

RetryHandlingFileSystemMasterClient

public interface FileSystemMasterClient
extends Client

A client to use for interacting with a file system master.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileSystemMasterClient.Factory Factory for FileSystemMasterClient.

Method Summary

Modifier and Type	Method and Description
void	checkAccess(AlluxioURI path, CheckAccessPOptions options) Check access to a path.
List<AlluxioURI>	checkConsistency(AlluxioURI path, CheckConsistencyPOptions options) Checks the consistency of Alluxio metadata against the under storage for all files and directories in a given subtree.
void	completeFile(AlluxioURI path, CompleteFilePOptions options) Marks a file as completed.
void	createDirectory(AlluxioURI path, CreateDirectoryPOptions options) Creates a new directory.
URIStatus	createFile(AlluxioURI path, CreateFilePOptions options) Creates a new file.
void	delete(AlluxioURI path, DeletePOptions options) Deletes a file or a directory.
boolean	exists(AlluxioURI path, ExistsPOptions options) Checks whether a file or directory exists.
void	free(AlluxioURI path, FreePOptions options) Frees a file.
String	getFilePath(long fileId)
String	getJobProgress(JobDescription jobDescription, JobProgressReportFormat format, boolean verbose) Get progress of a job.
long	getMountId(AlluxioURI ufsUri) Reverse resolve a ufs uri and get mount id.
default Map<String,MountPointInfo>	getMountTable() Lists all mount points and their corresponding under storage addresses.
Map<String,MountPointInfo>	getMountTable(boolean checkUfs) Lists all mount points and their corresponding under storage addresses.
long	getNewBlockIdForFile(AlluxioURI path)
List<String>	getStateLockHolders()
URIStatus	getStatus(AlluxioURI path, GetStatusPOptions options)
void	iterateStatus(AlluxioURI path, ListStatusPOptions options, java.util.function.Consumer<? super URIStatus> action) Performs a specific action on each URIStatus in the result of listStatus(alluxio.AlluxioURI, alluxio.grpc.ListStatusPOptions).
List<URIStatus>	listStatus(AlluxioURI path, ListStatusPOptions options)
ListStatusPartialResult	listStatusPartial(AlluxioURI path, ListStatusPartialPOptions options)
void	mount(AlluxioURI alluxioPath, AlluxioURI ufsPath, MountPOptions options) Mounts the given UFS path under the given Alluxio path.
void	needsSync(AlluxioURI path) Mark a path as needed synchronization with the UFS, when this path or any of its children are accessed, a sync with the UFS will be performed.
void	rename(AlluxioURI src, AlluxioURI dst) Renames a file or a directory.
void	rename(AlluxioURI src, AlluxioURI dst, RenamePOptions options) Renames a file or a directory.
AlluxioURI	reverseResolve(AlluxioURI ufsUri) Reverse resolve a ufs uri.
void	scheduleAsyncPersist(AlluxioURI path, ScheduleAsyncPersistencePOptions options) Schedules the async persistence of the given file.
void	setAcl(AlluxioURI path, SetAclAction action, List<AclEntry> entries, SetAclPOptions options) Sets the ACL for a path.
void	setAttribute(AlluxioURI path, SetAttributePOptions options) Sets the file or directory attributes.
boolean	stopJob(JobDescription jobDescription) Stop a job.
Optional<String>	submitJob(JobRequest job) Submit a job to scheduler.
void	unmount(AlluxioURI alluxioPath) Unmounts the given Alluxio path.
void	updateMount(AlluxioURI alluxioPath, MountPOptions options) Updates options of a mount point for the given Alluxio path.
void	updateUfsMode(AlluxioURI ufsUri, UpdateUfsModePOptions options) Updates the operation mode for the given ufs path.

Methods inherited from interface alluxio.Client

connect, disconnect, getConfAddress, getRemoteHostName, getRemoteSockAddress, isClosed, isConnected

Methods inherited from interface java.io.Closeable

close

Method Detail

checkAccess

void checkAccess(AlluxioURI path,
                 CheckAccessPOptions options)
          throws AlluxioStatusException

Check access to a path.

Parameters:

path - the path to check

options - method options

Throws:

AccessControlException - if the access is denied

AlluxioStatusException

checkConsistency

List<AlluxioURI> checkConsistency(AlluxioURI path,
                                  CheckConsistencyPOptions options)
                           throws AlluxioStatusException

Checks the consistency of Alluxio metadata against the under storage for all files and directories in a given subtree.

Parameters:

path - the root of the subtree to check

options - method options

Returns:

a list of inconsistent files and directories

Throws:

AlluxioStatusException

createDirectory

void createDirectory(AlluxioURI path,
                     CreateDirectoryPOptions options)
              throws AlluxioStatusException

Creates a new directory.

Parameters:

path - the directory path

options - method options

Throws:

AlreadyExistsException - if the directory already exists

AlluxioStatusException

createFile

URIStatus createFile(AlluxioURI path,
                     CreateFilePOptions options)
              throws AlluxioStatusException

Creates a new file.

Parameters:

path - the file path

options - method options

Returns:

the uri status of the newly created file

Throws:

AlreadyExistsException - if the file already exists

AlluxioStatusException

completeFile

void completeFile(AlluxioURI path,
                  CompleteFilePOptions options)
           throws AlluxioStatusException

Marks a file as completed.

Parameters:

path - the file path

options - the method options

Throws:

AlluxioStatusException

delete

void delete(AlluxioURI path,
            DeletePOptions options)
     throws AlluxioStatusException

Deletes a file or a directory.

Parameters:

path - the path to delete

options - method options

Throws:

AlluxioStatusException

exists

boolean exists(AlluxioURI path,
               ExistsPOptions options)
        throws AlluxioStatusException

Checks whether a file or directory exists.

Parameters:

path - the file path to check existence

options - the method options

Returns:

whether the file path exists

Throws:

AlluxioStatusException

free

void free(AlluxioURI path,
          FreePOptions options)
   throws AlluxioStatusException

Frees a file.

Parameters:

path - the path to free

options - method options

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

getFilePath

String getFilePath(long fileId)
            throws AlluxioStatusException

Parameters:

fileId - a file id

Returns:

the file path for the given file id

Throws:

AlluxioStatusException

getStatus

URIStatus getStatus(AlluxioURI path,
                    GetStatusPOptions options)
             throws AlluxioStatusException

Parameters:

path - the file path

options - the getStatus options

Returns:

the file info for the given file id

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

getNewBlockIdForFile

long getNewBlockIdForFile(AlluxioURI path)
                   throws AlluxioStatusException

Parameters:

path - the file path

Returns:

the next blockId for the file

Throws:

AlluxioStatusException

iterateStatus

void iterateStatus(AlluxioURI path,
                   ListStatusPOptions options,
                   java.util.function.Consumer<? super URIStatus> action)
            throws AlluxioStatusException

Performs a specific action on each URIStatus in the result of listStatus(alluxio.AlluxioURI, alluxio.grpc.ListStatusPOptions). This method is preferred when iterating over directories with a large number of files or sub-directories inside. The caller can proceed with partial result without waiting for all result returned.

Parameters:

path - the path to list information about

options - options to associate with this operation

action - action to apply on each URIStatus

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

listStatus

List<URIStatus> listStatus(AlluxioURI path,
                           ListStatusPOptions options)
                    throws AlluxioStatusException

Parameters:

path - the path to list

options - the listStatus options

Returns:

the list of file information for the given path

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

listStatusPartial

ListStatusPartialResult listStatusPartial(AlluxioURI path,
                                          ListStatusPartialPOptions options)
                                   throws AlluxioStatusException

Parameters:

path - the path to list

options - the listStatus partial options

Returns:

the list of file information for the given path

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

mount

void mount(AlluxioURI alluxioPath,
           AlluxioURI ufsPath,
           MountPOptions options)
    throws AlluxioStatusException

Mounts the given UFS path under the given Alluxio path.

Parameters:

alluxioPath - the Alluxio path

ufsPath - the UFS path

options - mount options

Throws:

AlluxioStatusException

updateMount

void updateMount(AlluxioURI alluxioPath,
                 MountPOptions options)
          throws AlluxioStatusException

Updates options of a mount point for the given Alluxio path.

Parameters:

alluxioPath - the Alluxio path

options - mount options

Throws:

AlluxioStatusException

getMountTable

default Map<String,MountPointInfo> getMountTable()
                                          throws AlluxioStatusException

Lists all mount points and their corresponding under storage addresses. This is the same as calling getMountTable(boolean) with true argument.

Returns:

a map from String to MountPointInfo

Throws:

AlluxioStatusException

getMountTable

Map<String,MountPointInfo> getMountTable(boolean checkUfs)
                                  throws AlluxioStatusException

Lists all mount points and their corresponding under storage addresses.

Parameters:

checkUfs - whether to get UFS usage info

Returns:

a map from String to MountPointInfo

Throws:

AlluxioStatusException

rename

void rename(AlluxioURI src,
            AlluxioURI dst)
     throws AlluxioStatusException

Renames a file or a directory.

Parameters:

src - the path to rename

dst - new file path

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

rename

void rename(AlluxioURI src,
            AlluxioURI dst,
            RenamePOptions options)
     throws AlluxioStatusException

Renames a file or a directory.

Parameters:

src - the path to rename

dst - new file path

options - rename options

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

reverseResolve

AlluxioURI reverseResolve(AlluxioURI ufsUri)
                   throws AlluxioStatusException

Reverse resolve a ufs uri.

Parameters:

ufsUri - the ufs uri

Returns:

the alluxio path for the ufsUri

Throws:

AlluxioStatusException

getMountId

long getMountId(AlluxioURI ufsUri)
         throws AlluxioStatusException

Reverse resolve a ufs uri and get mount id.

Parameters:

ufsUri - the ufs uri

Returns:

the mount id for the ufsUri

Throws:

AlluxioStatusException - if any error occurs

setAcl

void setAcl(AlluxioURI path,
            SetAclAction action,
            List<AclEntry> entries,
            SetAclPOptions options)
     throws AlluxioStatusException

Sets the ACL for a path.

Parameters:

path - the file or directory path

action - the set action to perform

entries - the ACL entries to use

options - the options for setting ACL

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

setAttribute

void setAttribute(AlluxioURI path,
                  SetAttributePOptions options)
           throws AlluxioStatusException

Sets the file or directory attributes.

Parameters:

path - the file or directory path

options - the file or directory attribute options to be set

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

scheduleAsyncPersist

void scheduleAsyncPersist(AlluxioURI path,
                          ScheduleAsyncPersistencePOptions options)
                   throws AlluxioStatusException

Schedules the async persistence of the given file.

Parameters:

path - the file path

options - options to use when scheduling the persist

Throws:

AlluxioStatusException

unmount

void unmount(AlluxioURI alluxioPath)
      throws AlluxioStatusException

Unmounts the given Alluxio path.

Parameters:

alluxioPath - the Alluxio path

Throws:

AlluxioStatusException

updateUfsMode

void updateUfsMode(AlluxioURI ufsUri,
                   UpdateUfsModePOptions options)
            throws AlluxioStatusException

Updates the operation mode for the given ufs path. The path is required to be the scheme and authority only. For example, to update the mode for under storage at hdfs://ns/folder1 specify the argument as hdfs://ns/. Note: the mode for any other mounted under storage which shares the prefix (such as hdfs://ns/folder2) is also updated.

Parameters:

ufsUri - the ufs path

options - the options to update ufs operation mode

Throws:

AlluxioStatusException

getStateLockHolders

List<String> getStateLockHolders()
                          throws AlluxioStatusException

Returns:

the state lock waiters and holders thread identifiers

Throws:

AlluxioStatusException

needsSync

void needsSync(AlluxioURI path)
        throws AlluxioStatusException

Mark a path as needed synchronization with the UFS, when this path or any of its children are accessed, a sync with the UFS will be performed.

Parameters:

path - the path to invalidate

Throws:

AlluxioStatusException

submitJob

Optional<String> submitJob(JobRequest job)

Submit a job to scheduler.

Parameters:

job - the job request to submit

Returns:

jobId if job is submitted, empty if a job already exists

stopJob

boolean stopJob(JobDescription jobDescription)

Stop a job.

Parameters:

jobDescription - job description be stopped

Returns:

true if job is stopped, false if we cannot find job

getJobProgress

String getJobProgress(JobDescription jobDescription,
                      JobProgressReportFormat format,
                      boolean verbose)

Get progress of a job.

Parameters:

jobDescription - job description to get progress

format - progress report format

verbose - whether to return verbose report

Returns:

the job progress