alluxio.thrift

Interface FileSystemMasterClientService.Iface

All Superinterfaces:

AlluxioService.Iface

All Known Implementing Classes:

FileSystemMasterClientService.Client, FileSystemMasterClientServiceHandler

Enclosing class:

FileSystemMasterClientService

public static interface FileSystemMasterClientService.Iface
extends AlluxioService.Iface

This interface contains file system master service endpoints for Alluxio clients.

Method Summary

Modifier and Type	Method and Description
CheckConsistencyTResponse	checkConsistency(String path, CheckConsistencyTOptions options) Checks the consistency of the files and directores with the path as the root of the subtree
CompleteFileTResponse	completeFile(String path, CompleteFileTOptions options) Marks a file as completed.
CreateDirectoryTResponse	createDirectory(String path, CreateDirectoryTOptions options) Creates a directory.
CreateFileTResponse	createFile(String path, CreateFileTOptions options) Creates a file.
FreeTResponse	free(String path, boolean recursive, FreeTOptions options) Frees the given file or directory from Alluxio.
GetFilePathTResponse	getFilePath(GetFilePathTOptions options) Returns the file path of a file id.
GetMountTableTResponse	getMountTable() Returns a map from each Alluxio path to information of corresponding mount point
GetNewBlockIdForFileTResponse	getNewBlockIdForFile(String path, GetNewBlockIdForFileTOptions options) Generates a new block id for the given file.
GetStatusTResponse	getStatus(String path, GetStatusTOptions options) Returns the status of the file or directory.
ListStatusTResponse	listStatus(String path, ListStatusTOptions options) If the path points to a file, the method returns a singleton with its file information.
LoadMetadataTResponse	loadMetadata(String ufsPath, boolean recursive, LoadMetadataTOptions options) Loads metadata for the object identified by the given Alluxio path from UFS into Alluxio.
MountTResponse	mount(String alluxioPath, String ufsPath, MountTOptions options) Creates a new "mount point", mounts the given UFS path in the Alluxio namespace at the given path.
DeleteTResponse	remove(String path, boolean recursive, DeleteTOptions options) Deletes a file or a directory and returns whether the remove operation succeeded.
RenameTResponse	rename(String path, String dstPath, RenameTOptions options) Renames a file or a directory.
ScheduleAsyncPersistenceTResponse	scheduleAsyncPersistence(String path, ScheduleAsyncPersistenceTOptions options) Schedules async persistence.
SetAttributeTResponse	setAttribute(String path, SetAttributeTOptions options) Sets file or directory attributes.
UnmountTResponse	unmount(String alluxioPath, UnmountTOptions options) Deletes an existing "mount point", voiding the Alluxio namespace at the given path.
UpdateUfsModeTResponse	updateUfsMode(String ufsPath, UpdateUfsModeTOptions options) Updates the ufs mode for a ufs path under one or more mount points.

Methods inherited from interface alluxio.thrift.AlluxioService.Iface

getServiceVersion

Method Detail

checkConsistency

CheckConsistencyTResponse checkConsistency(String path,
                                           CheckConsistencyTOptions options)
                                    throws AlluxioTException,
                                           org.apache.thrift.TException

Checks the consistency of the files and directores with the path as the root of the subtree

Parameters:

path - the root of the subtree to check

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

completeFile

CompleteFileTResponse completeFile(String path,
                                   CompleteFileTOptions options)
                            throws AlluxioTException,
                                   org.apache.thrift.TException

Marks a file as completed.

Parameters:

path - the path of the file

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

createDirectory

CreateDirectoryTResponse createDirectory(String path,
                                         CreateDirectoryTOptions options)
                                  throws AlluxioTException,
                                         org.apache.thrift.TException

Creates a directory.

Parameters:

path - the path of the directory

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

createFile

CreateFileTResponse createFile(String path,
                               CreateFileTOptions options)
                        throws AlluxioTException,
                               org.apache.thrift.TException

Creates a file.

Parameters:

path - the path of the file

options - the options for creating the file

Throws:

AlluxioTException

org.apache.thrift.TException

free

FreeTResponse free(String path,
                   boolean recursive,
                   FreeTOptions options)
            throws AlluxioTException,
                   org.apache.thrift.TException

Frees the given file or directory from Alluxio.

Parameters:

path - the path of the file or directory

recursive - whether to free recursively

options - the options for freeing a path

Throws:

AlluxioTException

org.apache.thrift.TException

getMountTable

GetMountTableTResponse getMountTable()
                              throws AlluxioTException,
                                     org.apache.thrift.TException

Returns a map from each Alluxio path to information of corresponding mount point

Throws:

AlluxioTException

org.apache.thrift.TException

getNewBlockIdForFile

GetNewBlockIdForFileTResponse getNewBlockIdForFile(String path,
                                                   GetNewBlockIdForFileTOptions options)
                                            throws AlluxioTException,
                                                   org.apache.thrift.TException

Generates a new block id for the given file.

Parameters:

path - the path of the file

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

getFilePath

GetFilePathTResponse getFilePath(GetFilePathTOptions options)
                          throws AlluxioTException,
                                 org.apache.thrift.TException

Returns the file path of a file id.

Parameters:

options - the file id

Throws:

AlluxioTException

org.apache.thrift.TException

getStatus

GetStatusTResponse getStatus(String path,
                             GetStatusTOptions options)
                      throws AlluxioTException,
                             org.apache.thrift.TException

Returns the status of the file or directory.

Parameters:

path - the path of the file or directory

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

listStatus

ListStatusTResponse listStatus(String path,
                               ListStatusTOptions options)
                        throws AlluxioTException,
                               org.apache.thrift.TException

If the path points to a file, the method returns a singleton with its file information. If the path points to a directory, the method returns a list with file information for the directory contents.

Parameters:

path - the path of the file or directory

options - listStatus options

Throws:

AlluxioTException

org.apache.thrift.TException

loadMetadata

LoadMetadataTResponse loadMetadata(String ufsPath,
                                   boolean recursive,
                                   LoadMetadataTOptions options)
                            throws AlluxioTException,
                                   org.apache.thrift.TException

Loads metadata for the object identified by the given Alluxio path from UFS into Alluxio. THIS METHOD IS DEPRECATED SINCE VERSION 1.1 AND WILL BE REMOVED IN VERSION 2.0.

Parameters:

ufsPath - the path of the under file system

recursive - whether to load metadata recursively

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

mount

MountTResponse mount(String alluxioPath,
                     String ufsPath,
                     MountTOptions options)
              throws AlluxioTException,
                     org.apache.thrift.TException

Creates a new "mount point", mounts the given UFS path in the Alluxio namespace at the given path. The path should not exist and should not be nested under any existing mount point.

Parameters:

alluxioPath - the path of alluxio mount point

ufsPath - the path of the under file system

options - the options for creating the mount point

Throws:

AlluxioTException

org.apache.thrift.TException

remove

DeleteTResponse remove(String path,
                       boolean recursive,
                       DeleteTOptions options)
                throws AlluxioTException,
                       org.apache.thrift.TException

Deletes a file or a directory and returns whether the remove operation succeeded. NOTE: Unfortunately, the method cannot be called "delete" as that is a reserved Thrift keyword.

Parameters:

path - the path of the file or directory

recursive - whether to remove recursively

options - the options for deleting the file

Throws:

AlluxioTException

org.apache.thrift.TException

rename

RenameTResponse rename(String path,
                       String dstPath,
                       RenameTOptions options)
                throws AlluxioTException,
                       org.apache.thrift.TException

Renames a file or a directory.

Parameters:

path - the source path of the file or directory

dstPath - the desination path of the file

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

scheduleAsyncPersistence

ScheduleAsyncPersistenceTResponse scheduleAsyncPersistence(String path,
                                                           ScheduleAsyncPersistenceTOptions options)
                                                    throws AlluxioTException,
                                                           org.apache.thrift.TException

Schedules async persistence.

Parameters:

path - the path of the file

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

setAttribute

SetAttributeTResponse setAttribute(String path,
                                   SetAttributeTOptions options)
                            throws AlluxioTException,
                                   org.apache.thrift.TException

Sets file or directory attributes.

Parameters:

path - the path of the file or directory

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

unmount

UnmountTResponse unmount(String alluxioPath,
                         UnmountTOptions options)
                  throws AlluxioTException,
                         org.apache.thrift.TException

Deletes an existing "mount point", voiding the Alluxio namespace at the given path. The path should correspond to an existing mount point. Any files in its subtree that are backed by UFS will be persisted before they are removed from the Alluxio namespace.

Parameters:

alluxioPath - the path of the alluxio mount point

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

updateUfsMode

UpdateUfsModeTResponse updateUfsMode(String ufsPath,
                                     UpdateUfsModeTOptions options)
                              throws AlluxioTException,
                                     org.apache.thrift.TException

Updates the ufs mode for a ufs path under one or more mount points.

Parameters:

ufsPath - the ufs path

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException