Java SDK Documentation  12.0.0
com.vertica.sdk.DFSFile Class Reference
Collaboration diagram for com.vertica.sdk.DFSFile:
Collaboration graph

Classes

enum  DFSDistribution
 
enum  DFSRootParentType
 
enum  DFSScope
 

Public Member Functions

 DFSFile ()
 
 DFSFile (ServerInterface srvInterface)
 
 DFSFile (ServerInterface srvInterface, String fName) throws UdfException, DestroyInvocation
 
 DFSFile (ServerInterface srvInterface, String fName, DFSRootParentType parentType, String parentName) throws UdfException, DestroyInvocation
 
 DFSFile (String fName, FileManager fmgr) throws UdfException, DestroyInvocation
 
 DFSFile (String fName, FileManager fmgr, boolean is_dir, boolean is_file, boolean exists, long fSize) throws UdfException, DestroyInvocation
 
void create (DFSScope dfsScope, DFSDistribution dfsDistrib) throws UdfException, DestroyInvocation
 
int deleteIt (boolean isRecursively) throws UdfException, DestroyInvocation
 
boolean exists () throws UdfException
 
DFSRootParentType getDFSRootParentType ()
 
DFSDistribution getDistribution ()
 
FileManager getFileManager ()
 
long getFileWriter ()
 
String getName ()
 
String getRootDFSParentObjectName ()
 
DFSScope getScope ()
 
ServerInterface getServerInterface ()
 
long getSize ()
 
DFSFileStatus getStatus ()
 
boolean isDir ()
 
boolean isFile ()
 
List< DFSFilelistFiles () throws UdfException, DestroyInvocation
 
void setDir (boolean thisIsaDirectory)
 
void setDistribution (DFSDistribution dfsDist)
 
void setFile (boolean thisIsaFile)
 
void setFileManager (ServerInterface srvInterface)
 
void setName (String fName) throws UdfException, DestroyInvocation
 
void setScope (DFSScope dfsScope)
 
void setSize (long fSize)
 
void setStatus (DFSFileStatus dfsStatus)
 

Detailed Description

The main class used by users to initiate DFS operations

Constructor & Destructor Documentation

com.vertica.sdk.DFSFile.DFSFile ( )

DFSFile INITIATION IS ONLY AVAILABLE DURING THE PLANNING/SETUP AND FINALIZE/DESTROY PHASES OF A PLAN. NOT AVAILABLE DURING EXECUTION/PROCESSING.

Member Function Documentation

int com.vertica.sdk.DFSFile.deleteIt ( boolean  isRecursively) throws UdfException, DestroyInvocation

Deletes a DFS file.

Parameters
isRecursivelydelete recursively
Returns
0 is successful, throw exceptions if there are errors.
Exceptions
UdfExceptionUDF problem
DestroyInvocationvertica canceling – do not catch or handle
List<DFSFile> com.vertica.sdk.DFSFile.listFiles ( ) throws UdfException, DestroyInvocation

Lists files under the path specified by 'fileName'

Returns
a list of DFSFile found under the path.
Exceptions
UdfExceptionUDF problem
DestroyInvocationvertica canceling – do not catch or handle