com.gpudb.protocol

Class ShowTablesByTypeRequest

java.lang.Object

com.gpudb.protocol.ShowTablesByTypeRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.showTablesByType(ShowTablesByTypeRequest).

Gets names of the tables whose type matches the given criteria. Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Constructor Summary

Constructors

Constructor and Description
ShowTablesByTypeRequest() Constructs a ShowTablesByTypeRequest object with default parameters.
ShowTablesByTypeRequest(String typeId, String label, Map<String,String> options) Constructs a ShowTablesByTypeRequest 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	getLabel()
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.
String	getTypeId()
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.
ShowTablesByTypeRequest	setLabel(String label)
ShowTablesByTypeRequest	setOptions(Map<String,String> options)
ShowTablesByTypeRequest	setTypeId(String typeId)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowTablesByTypeRequest

public ShowTablesByTypeRequest()

Constructs a ShowTablesByTypeRequest object with default parameters.

ShowTablesByTypeRequest

public ShowTablesByTypeRequest(String typeId,
                               String label,
                               Map<String,String> options)

Constructs a ShowTablesByTypeRequest object with the specified parameters.

Parameters:

typeId - Type id returned by a call to GPUdb.createType(CreateTypeRequest).

label - Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.

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.

getTypeId

public String getTypeId()

Returns:

Type id returned by a call to GPUdb.createType(CreateTypeRequest).

setTypeId

public ShowTablesByTypeRequest setTypeId(String typeId)

Parameters:

typeId - Type id returned by a call to GPUdb.createType(CreateTypeRequest).

Returns:

this to mimic the builder pattern.

getLabel

public String getLabel()

Returns:

Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.

setLabel

public ShowTablesByTypeRequest setLabel(String label)

Parameters:

label - Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.

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 ShowTablesByTypeRequest 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