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.IndexedRecord

public class DeleteDirectoryRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.deleteDirectory.

Deletes a directory from KiFS.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteDirectoryRequest.Options	A set of string constants for the DeleteDirectoryRequest parameter options.

Constructor Summary

Constructors

Constructor	Description
DeleteDirectoryRequest()	Constructs 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 Type	Method	Description
boolean	equals(Object obj)
Object	get(int index)	This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
String	getDirectoryName()	Name of the directory in KiFS to be deleted.
Map<String,String>	getOptions()	Optional parameters.
org.apache.avro.Schema	getSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value)	This method supports the Avro framework and is not intended to be called directly by the user.
DeleteDirectoryRequest	setDirectoryName(String directoryName)	Name of the directory in KiFS to be deleted.
DeleteDirectoryRequest	setOptions(Map<String,String> options)	Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteDirectoryRequest

public DeleteDirectoryRequest()

Constructs a DeleteDirectoryRequest object with default parameters.

DeleteDirectoryRequest

public DeleteDirectoryRequest(String directoryName,
                              Map<String,String> options)

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, unless RECURSIVE is TRUE

options - Optional parameters.

• RECURSIVE: If TRUE, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• NO_ERROR_IF_NOT_EXISTS: If TRUE, no error is returned if specified directory does not exist. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

The schema for the class.

getDirectoryName

public String getDirectoryName()

Name of the directory in KiFS to be deleted. The directory must contain no files, unless RECURSIVE is TRUE

Returns:

The current value of directoryName.

setDirectoryName

public DeleteDirectoryRequest setDirectoryName(String directoryName)

Name of the directory in KiFS to be deleted. The directory must contain no files, unless RECURSIVE is TRUE

Parameters:

directoryName - The new value for directoryName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• RECURSIVE: If TRUE, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• NO_ERROR_IF_NOT_EXISTS: If TRUE, no error is returned if specified directory does not exist. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

public DeleteDirectoryRequest setOptions(Map<String,String> options)

Optional parameters.

• RECURSIVE: If TRUE, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• NO_ERROR_IF_NOT_EXISTS: If TRUE, no error is returned if specified directory does not exist. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Parameters:

options - The new value for options.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

The schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object