alluxio.thrift

Interface FileSystemWorkerClientService.Iface

All Superinterfaces:

AlluxioService.Iface

All Known Implementing Classes:

FileSystemWorkerClientService.Client, FileSystemWorkerClientServiceHandler

Enclosing class:

FileSystemWorkerClientService

public static interface FileSystemWorkerClientService.Iface
extends AlluxioService.Iface

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

Method Summary

Modifier and Type	Method and Description
CancelUfsFileTResponse	cancelUfsFile(long sessionId, long tempUfsFileId, CancelUfsFileTOptions options) Cancels a file which has not been completed in the under file system.
CloseUfsFileTResponse	closeUfsFile(long sessionId, long tempUfsFileId, CloseUfsFileTOptions options) Closes a file in the under file system which was previously opened for reading.
CompleteUfsFileTReponse	completeUfsFile(long sessionId, long tempUfsFileId, CompleteUfsFileTOptions options) Completes a file in the under file system.
CreateUfsFileTResponse	createUfsFile(long sessionId, String ufsPath, CreateUfsFileTOptions options) Creates a file in the under file system.
OpenUfsFileTResponse	openUfsFile(long sessionId, String ufsPath, OpenUfsFileTOptions options) Opens an existing file in the under file system for reading.
SessionFileSystemHeartbeatTResponse	sessionFileSystemHeartbeat(long sessionId, List<Long> metrics, SessionFileSystemHeartbeatTOptions options) Local session send heartbeat to local worker to keep its state.

Methods inherited from interface alluxio.thrift.AlluxioService.Iface

getServiceVersion

Method Detail

cancelUfsFile

CancelUfsFileTResponse cancelUfsFile(long sessionId,
                                     long tempUfsFileId,
                                     CancelUfsFileTOptions options)
                              throws AlluxioTException,
                                     org.apache.thrift.TException

Cancels a file which has not been completed in the under file system.

Parameters:

sessionId - the id of the current session

tempUfsFileId - the worker specific file id of the ufs file

options - the options for canceling the file

Throws:

AlluxioTException

org.apache.thrift.TException

closeUfsFile

CloseUfsFileTResponse closeUfsFile(long sessionId,
                                   long tempUfsFileId,
                                   CloseUfsFileTOptions options)
                            throws AlluxioTException,
                                   org.apache.thrift.TException

Closes a file in the under file system which was previously opened for reading.

Parameters:

sessionId - the id of the current session

tempUfsFileId - the worker specific file id of the ufs file

options - the options for closing the file

Throws:

AlluxioTException

org.apache.thrift.TException

completeUfsFile

CompleteUfsFileTReponse completeUfsFile(long sessionId,
                                        long tempUfsFileId,
                                        CompleteUfsFileTOptions options)
                                 throws AlluxioTException,
                                        org.apache.thrift.TException

Completes a file in the under file system.

Parameters:

sessionId - the id of the current session

tempUfsFileId - the worker specific file id of the ufs file

options - the options for completing the file

Throws:

AlluxioTException

org.apache.thrift.TException

createUfsFile

CreateUfsFileTResponse createUfsFile(long sessionId,
                                     String ufsPath,
                                     CreateUfsFileTOptions options)
                              throws AlluxioTException,
                                     org.apache.thrift.TException

Creates a file in the under file system.

Parameters:

sessionId - the id of the current session

ufsPath - the path of the file in the ufs

options - the options for creating the file

Throws:

AlluxioTException

org.apache.thrift.TException

openUfsFile

OpenUfsFileTResponse openUfsFile(long sessionId,
                                 String ufsPath,
                                 OpenUfsFileTOptions options)
                          throws AlluxioTException,
                                 org.apache.thrift.TException

Opens an existing file in the under file system for reading.

Parameters:

sessionId - the id of the current session

ufsPath - the path of the file in the ufs

options - the options for opening the file

Throws:

AlluxioTException

org.apache.thrift.TException

sessionFileSystemHeartbeat

SessionFileSystemHeartbeatTResponse sessionFileSystemHeartbeat(long sessionId,
                                                               List<Long> metrics,
                                                               SessionFileSystemHeartbeatTOptions options)
                                                        throws AlluxioTException,
                                                               org.apache.thrift.TException

Local session send heartbeat to local worker to keep its state.

Parameters:

sessionId - the id of the current session

metrics - the client metrics. deprecated since 1.3.0 and will be removed in 2.0

options - the method options

Throws:

AlluxioTException

org.apache.thrift.TException