com.gpudb.protocol

Class ShowDirectoriesRequest

java.lang.Object

com.gpudb.protocol.ShowDirectoriesRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

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

A set of parameters for GPUdb.showDirectories(ShowDirectoriesRequest).

Shows information about directories in KiFS. Can be used to show a single directory, or all directories.

Constructor Summary

Constructors

Constructor and Description
ShowDirectoriesRequest() Constructs a ShowDirectoriesRequest object with default parameters.
ShowDirectoriesRequest(String directoryName, Map<String,String> options) Constructs a ShowDirectoriesRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and 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()
Map<String,String>	getOptions()
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.
ShowDirectoriesRequest	setDirectoryName(String directoryName)
ShowDirectoriesRequest	setOptions(Map<String,String> options)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowDirectoriesRequest

public ShowDirectoriesRequest()

Constructs a ShowDirectoriesRequest object with default parameters.

ShowDirectoriesRequest

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

Constructs a ShowDirectoriesRequest object with the specified parameters.

Parameters:

directoryName - The KiFS directory name to show. If empty, shows all directories. The default value is ''.

options - Optional parameters. 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()

Returns:

The KiFS directory name to show. If empty, shows all directories. The default value is ''.

setDirectoryName

public ShowDirectoriesRequest setDirectoryName(String directoryName)

Parameters:

directoryName - The KiFS directory name to show. If empty, shows all directories. The default value is ''.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters. The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters. The default value is an empty Map.

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