Package com.gpudb.protocol
Class DeleteDirectoryRequest
java.lang.Object
com.gpudb.protocol.DeleteDirectoryRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecordA set of parameters for
GPUdb.deleteDirectory.
Deletes a directory from KiFS.
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theDeleteDirectoryRequestparameteroptions.Constructor Summary
ConstructorsConstructorDescriptionConstructs a DeleteDirectoryRequest object with default parameters.DeleteDirectoryRequest(String directoryName, Map<String, String> options) Constructs a DeleteDirectoryRequest object with the specified parameters.Method Summary
Modifier and TypeMethodDescriptionbooleanget(int index) This method supports the Avro framework and is not intended to be called directly by the user.static org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.Name of the directory in KiFS to be deleted.Optional parameters.org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.inthashCode()voidThis method supports the Avro framework and is not intended to be called directly by the user.setDirectoryName(String directoryName) Name of the directory in KiFS to be deleted.setOptions(Map<String, String> options) Optional parameters.toString()
Constructor Details
DeleteDirectoryRequest
Constructs a DeleteDirectoryRequest object with the specified parameters.Parameters:directoryName- Name of the directory in KiFS to be deleted. The directory must contain no files, unlessRECURSIVEisTRUE.options- Optional parameters.RECURSIVE: IfTRUE, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:The default value isFALSE.NO_ERROR_IF_NOT_EXISTS: IfTRUE, no error is returned if specified directory does not exist. Supported values:The default value isFALSE.
Map.
Method Details
getOptions
Optional parameters.RECURSIVE: IfTRUE, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:The default value isFALSE.NO_ERROR_IF_NOT_EXISTS: IfTRUE, no error is returned if specified directory does not exist. Supported values:The default value isFALSE.
Map.Returns:The current value ofoptions.setOptions
Optional parameters.RECURSIVE: IfTRUE, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:The default value isFALSE.NO_ERROR_IF_NOT_EXISTS: IfTRUE, no error is returned if specified directory does not exist. Supported values:The default value isFALSE.
Map.Parameters:options- The new value foroptions.Returns:thisto mimic the builder pattern.