alluxio.thrift

Class FileSystemMasterClientService.Client

java.lang.Object

org.apache.thrift.TServiceClient

alluxio.thrift.AlluxioService.Client

alluxio.thrift.FileSystemMasterClientService.Client

All Implemented Interfaces:

AlluxioService.Iface, FileSystemMasterClientService.Iface

Enclosing class:

FileSystemMasterClientService

public static class FileSystemMasterClientService.Client
extends AlluxioService.Client
implements FileSystemMasterClientService.Iface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSystemMasterClientService.Client.Factory

Field Summary

Fields inherited from class org.apache.thrift.TServiceClient

iprot_, oprot_, seqid_

Constructor Summary

Constructors

Constructor and Description
Client(org.apache.thrift.protocol.TProtocol prot)
Client(org.apache.thrift.protocol.TProtocol iprot, org.apache.thrift.protocol.TProtocol oprot)

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.
CheckConsistencyTResponse	recv_checkConsistency()
CompleteFileTResponse	recv_completeFile()
CreateDirectoryTResponse	recv_createDirectory()
CreateFileTResponse	recv_createFile()
FreeTResponse	recv_free()
GetFilePathTResponse	recv_getFilePath()
GetMountTableTResponse	recv_getMountTable()
GetNewBlockIdForFileTResponse	recv_getNewBlockIdForFile()
GetStatusTResponse	recv_getStatus()
ListStatusTResponse	recv_listStatus()
LoadMetadataTResponse	recv_loadMetadata()
MountTResponse	recv_mount()
DeleteTResponse	recv_remove()
RenameTResponse	recv_rename()
ScheduleAsyncPersistenceTResponse	recv_scheduleAsyncPersistence()
SetAttributeTResponse	recv_setAttribute()
UnmountTResponse	recv_unmount()
UpdateUfsModeTResponse	recv_updateUfsMode()
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.
void	send_checkConsistency(String path, CheckConsistencyTOptions options)
void	send_completeFile(String path, CompleteFileTOptions options)
void	send_createDirectory(String path, CreateDirectoryTOptions options)
void	send_createFile(String path, CreateFileTOptions options)
void	send_free(String path, boolean recursive, FreeTOptions options)
void	send_getFilePath(GetFilePathTOptions options)
void	send_getMountTable()
void	send_getNewBlockIdForFile(String path, GetNewBlockIdForFileTOptions options)
void	send_getStatus(String path, GetStatusTOptions options)
void	send_listStatus(String path, ListStatusTOptions options)
void	send_loadMetadata(String ufsPath, boolean recursive, LoadMetadataTOptions options)
void	send_mount(String alluxioPath, String ufsPath, MountTOptions options)
void	send_remove(String path, boolean recursive, DeleteTOptions options)
void	send_rename(String path, String dstPath, RenameTOptions options)
void	send_scheduleAsyncPersistence(String path, ScheduleAsyncPersistenceTOptions options)
void	send_setAttribute(String path, SetAttributeTOptions options)
void	send_unmount(String alluxioPath, UnmountTOptions options)
void	send_updateUfsMode(String ufsPath, UpdateUfsModeTOptions options)
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 class alluxio.thrift.AlluxioService.Client

getServiceVersion, recv_getServiceVersion, send_getServiceVersion

Methods inherited from class org.apache.thrift.TServiceClient

getInputProtocol, getOutputProtocol, receiveBase, sendBase, sendBaseOneway

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface alluxio.thrift.AlluxioService.Iface

getServiceVersion

Constructor Detail

Client

public Client(org.apache.thrift.protocol.TProtocol prot)

Client

public Client(org.apache.thrift.protocol.TProtocol iprot,
              org.apache.thrift.protocol.TProtocol oprot)

Method Detail

checkConsistency

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

Description copied from interface: FileSystemMasterClientService.Iface

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

Specified by:

checkConsistency in interface FileSystemMasterClientService.Iface

Parameters:

path - the root of the subtree to check

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

send_checkConsistency

public void send_checkConsistency(String path,
                                  CheckConsistencyTOptions options)
                           throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_checkConsistency

public CheckConsistencyTResponse recv_checkConsistency()
                                                throws AlluxioTException,
                                                       org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

completeFile

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

Description copied from interface: FileSystemMasterClientService.Iface

Marks a file as completed.

Specified by:

completeFile in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

send_completeFile

public void send_completeFile(String path,
                              CompleteFileTOptions options)
                       throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_completeFile

public CompleteFileTResponse recv_completeFile()
                                        throws AlluxioTException,
                                               org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

createDirectory

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

Description copied from interface: FileSystemMasterClientService.Iface

Creates a directory.

Specified by:

createDirectory in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the directory

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

send_createDirectory

public void send_createDirectory(String path,
                                 CreateDirectoryTOptions options)
                          throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_createDirectory

public CreateDirectoryTResponse recv_createDirectory()
                                              throws AlluxioTException,
                                                     org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

createFile

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

Description copied from interface: FileSystemMasterClientService.Iface

Creates a file.

Specified by:

createFile in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file

options - the options for creating the file

Throws:

AlluxioTException

org.apache.thrift.TException

send_createFile

public void send_createFile(String path,
                            CreateFileTOptions options)
                     throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_createFile

public CreateFileTResponse recv_createFile()
                                    throws AlluxioTException,
                                           org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

free

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

Description copied from interface: FileSystemMasterClientService.Iface

Frees the given file or directory from Alluxio.

Specified by:

free in interface FileSystemMasterClientService.Iface

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

send_free

public void send_free(String path,
                      boolean recursive,
                      FreeTOptions options)
               throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_free

public FreeTResponse recv_free()
                        throws AlluxioTException,
                               org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

getMountTable

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

Description copied from interface: FileSystemMasterClientService.Iface

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

Specified by:

getMountTable in interface FileSystemMasterClientService.Iface

Throws:

AlluxioTException

org.apache.thrift.TException

send_getMountTable

public void send_getMountTable()
                        throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_getMountTable

public GetMountTableTResponse recv_getMountTable()
                                          throws AlluxioTException,
                                                 org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

getNewBlockIdForFile

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

Description copied from interface: FileSystemMasterClientService.Iface

Generates a new block id for the given file.

Specified by:

getNewBlockIdForFile in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

send_getNewBlockIdForFile

public void send_getNewBlockIdForFile(String path,
                                      GetNewBlockIdForFileTOptions options)
                               throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_getNewBlockIdForFile

public GetNewBlockIdForFileTResponse recv_getNewBlockIdForFile()
                                                        throws AlluxioTException,
                                                               org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

getFilePath

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

Description copied from interface: FileSystemMasterClientService.Iface

Returns the file path of a file id.

Specified by:

getFilePath in interface FileSystemMasterClientService.Iface

Parameters:

options - the file id

Throws:

AlluxioTException

org.apache.thrift.TException

send_getFilePath

public void send_getFilePath(GetFilePathTOptions options)
                      throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_getFilePath

public GetFilePathTResponse recv_getFilePath()
                                      throws AlluxioTException,
                                             org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

getStatus

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

Description copied from interface: FileSystemMasterClientService.Iface

Returns the status of the file or directory.

Specified by:

getStatus in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file or directory

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

send_getStatus

public void send_getStatus(String path,
                           GetStatusTOptions options)
                    throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_getStatus

public GetStatusTResponse recv_getStatus()
                                  throws AlluxioTException,
                                         org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

listStatus

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

Description copied from interface: FileSystemMasterClientService.Iface

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.

Specified by:

listStatus in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file or directory

options - listStatus options

Throws:

AlluxioTException

org.apache.thrift.TException

send_listStatus

public void send_listStatus(String path,
                            ListStatusTOptions options)
                     throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_listStatus

public ListStatusTResponse recv_listStatus()
                                    throws AlluxioTException,
                                           org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

loadMetadata

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

Description copied from interface: FileSystemMasterClientService.Iface

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.

Specified by:

loadMetadata in interface FileSystemMasterClientService.Iface

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

send_loadMetadata

public void send_loadMetadata(String ufsPath,
                              boolean recursive,
                              LoadMetadataTOptions options)
                       throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_loadMetadata

public LoadMetadataTResponse recv_loadMetadata()
                                        throws AlluxioTException,
                                               org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

mount

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

Description copied from interface: FileSystemMasterClientService.Iface

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.

Specified by:

mount in interface FileSystemMasterClientService.Iface

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

send_mount

public void send_mount(String alluxioPath,
                       String ufsPath,
                       MountTOptions options)
                throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_mount

public MountTResponse recv_mount()
                          throws AlluxioTException,
                                 org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

remove

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

Description copied from interface: FileSystemMasterClientService.Iface

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.

Specified by:

remove in interface FileSystemMasterClientService.Iface

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

send_remove

public void send_remove(String path,
                        boolean recursive,
                        DeleteTOptions options)
                 throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_remove

public DeleteTResponse recv_remove()
                            throws AlluxioTException,
                                   org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

rename

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

Description copied from interface: FileSystemMasterClientService.Iface

Renames a file or a directory.

Specified by:

rename in interface FileSystemMasterClientService.Iface

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

send_rename

public void send_rename(String path,
                        String dstPath,
                        RenameTOptions options)
                 throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_rename

public RenameTResponse recv_rename()
                            throws AlluxioTException,
                                   org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

scheduleAsyncPersistence

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

Description copied from interface: FileSystemMasterClientService.Iface

Schedules async persistence.

Specified by:

scheduleAsyncPersistence in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

send_scheduleAsyncPersistence

public void send_scheduleAsyncPersistence(String path,
                                          ScheduleAsyncPersistenceTOptions options)
                                   throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_scheduleAsyncPersistence

public ScheduleAsyncPersistenceTResponse recv_scheduleAsyncPersistence()
                                                                throws AlluxioTException,
                                                                       org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

setAttribute

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

Description copied from interface: FileSystemMasterClientService.Iface

Sets file or directory attributes.

Specified by:

setAttribute in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file or directory

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

send_setAttribute

public void send_setAttribute(String path,
                              SetAttributeTOptions options)
                       throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_setAttribute

public SetAttributeTResponse recv_setAttribute()
                                        throws AlluxioTException,
                                               org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

unmount

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

Description copied from interface: FileSystemMasterClientService.Iface

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.

Specified by:

unmount in interface FileSystemMasterClientService.Iface

Parameters:

alluxioPath - the path of the alluxio mount point

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

send_unmount

public void send_unmount(String alluxioPath,
                         UnmountTOptions options)
                  throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_unmount

public UnmountTResponse recv_unmount()
                              throws AlluxioTException,
                                     org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException

updateUfsMode

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

Description copied from interface: FileSystemMasterClientService.Iface

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

Specified by:

updateUfsMode in interface FileSystemMasterClientService.Iface

Parameters:

ufsPath - the ufs path

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException

send_updateUfsMode

public void send_updateUfsMode(String ufsPath,
                               UpdateUfsModeTOptions options)
                        throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

recv_updateUfsMode

public UpdateUfsModeTResponse recv_updateUfsMode()
                                          throws AlluxioTException,
                                                 org.apache.thrift.TException

Throws:

AlluxioTException

org.apache.thrift.TException