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
List<AlluxioURI>	checkConsistency(AlluxioURI path, CheckConsistencyOptions options) Checks the consistency of Alluxio metadata against the under storage for all files and directories in a given subtree.
void	completeFile(AlluxioURI path, CompleteFileOptions options) Marks a file as completed.
void	createDirectory(AlluxioURI path, CreateDirectoryOptions options) Creates a new directory.
void	createFile(AlluxioURI path, CreateFileOptions options) Creates a new file.
void	delete(AlluxioURI path, DeleteOptions options) Deletes a file or a directory.
void	free(AlluxioURI path, FreeOptions options) Frees a file.
String	getFilePath(GetFilePathTOptions options)
Map<String,MountPointInfo>	getMountTable() Lists all mount points and their corresponding under storage addresses.
long	getNewBlockIdForFile(AlluxioURI path)
URIStatus	getStatus(AlluxioURI path, GetStatusOptions options)
List<URIStatus>	listStatus(AlluxioURI path, ListStatusOptions options)
void	loadMetadata(AlluxioURI path, LoadMetadataOptions options) Deprecated. since version 1.1 and will be removed in version 2.0
void	mount(AlluxioURI alluxioPath, AlluxioURI ufsPath, MountOptions options) Mounts the given UFS path under the given Alluxio path.
void	rename(AlluxioURI src, AlluxioURI dst) Renames a file or a directory.
void	rename(AlluxioURI src, AlluxioURI dst, RenameOptions options) Renames a file or a directory.
void	scheduleAsyncPersist(AlluxioURI path) Schedules the async persistence of the given file.
void	setAttribute(AlluxioURI path, SetAttributeOptions options) Sets the file or directory attributes.
void	unmount(AlluxioURI alluxioPath) Unmounts the given Alluxio path.
void	updateUfsMode(AlluxioURI ufsUri, UpdateUfsModeOptions options) Updates the operation mode for the given ufs path.

Methods inherited from interface alluxio.Client

connect, disconnect, getAddress, isConnected

Methods inherited from interface java.io.Closeable

close

Method Detail

checkConsistency

List<AlluxioURI> checkConsistency(AlluxioURI path,
                                  CheckConsistencyOptions 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,
                     CreateDirectoryOptions options)
              throws AlluxioStatusException

Creates a new directory.

Parameters:

path - the directory path

options - method options

Throws:

AlreadyExistsException - if the directory already exists

AlluxioStatusException

createFile

void createFile(AlluxioURI path,
                CreateFileOptions options)
         throws AlluxioStatusException

Creates a new file.

Parameters:

path - the file path

options - method options

Throws:

AlreadyExistsException - if the file already exists

AlluxioStatusException

completeFile

void completeFile(AlluxioURI path,
                  CompleteFileOptions options)
           throws AlluxioStatusException

Marks a file as completed.

Parameters:

path - the file path

options - the method options

Throws:

AlluxioStatusException

delete

void delete(AlluxioURI path,
            DeleteOptions options)
     throws AlluxioStatusException

Deletes a file or a directory.

Parameters:

path - the path to delete

options - method options

Throws:

AlluxioStatusException

free

void free(AlluxioURI path,
          FreeOptions 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(GetFilePathTOptions options)
            throws AlluxioStatusException

Parameters:

options - the getFilePath options

Returns:

the file path for the given file id

Throws:

AlluxioStatusException

getStatus

URIStatus getStatus(AlluxioURI path,
                    GetStatusOptions 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

listStatus

List<URIStatus> listStatus(AlluxioURI path,
                           ListStatusOptions 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

loadMetadata

@Deprecated
void loadMetadata(AlluxioURI path,
                              LoadMetadataOptions options)
                       throws AlluxioStatusException

Deprecated. since version 1.1 and will be removed in version 2.0

Loads the metadata of a file from the under file system.

Parameters:

path - the path of the file to load metadata for

options - method options

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

mount

void mount(AlluxioURI alluxioPath,
           AlluxioURI ufsPath,
           MountOptions 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

getMountTable

Map<String,MountPointInfo> getMountTable()
                                  throws AlluxioStatusException

Lists all mount points and their corresponding under storage addresses.

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,
            RenameOptions 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

setAttribute

void setAttribute(AlluxioURI path,
                  SetAttributeOptions 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)
                   throws AlluxioStatusException

Schedules the async persistence of the given file.

Parameters:

path - the file path

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,
                   UpdateUfsModeOptions 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