com.gpudb.protocol

Class ShowTableMetadataRequest

java.lang.Object

com.gpudb.protocol.ShowTableMetadataRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.showTableMetadata(ShowTableMetadataRequest).

Retrieves the user provided metadata for the specified tables.

Constructor Summary

Constructors

Constructor and Description
ShowTableMetadataRequest() Constructs a ShowTableMetadataRequest object with default parameters.
ShowTableMetadataRequest(List<String> tableNames, Map<String,String> options) Constructs a ShowTableMetadataRequest 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.
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.
List<String>	getTableNames()
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.
ShowTableMetadataRequest	setOptions(Map<String,String> options)
ShowTableMetadataRequest	setTableNames(List<String> tableNames)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowTableMetadataRequest

public ShowTableMetadataRequest()

Constructs a ShowTableMetadataRequest object with default parameters.

ShowTableMetadataRequest

public ShowTableMetadataRequest(List<String> tableNames,
                                Map<String,String> options)

Constructs a ShowTableMetadataRequest object with the specified parameters.

Parameters:

tableNames - Tables whose metadata will be fetched. All provided tables must exist, or an error is returned.

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.

getTableNames

public List<String> getTableNames()

Returns:

Tables whose metadata will be fetched. All provided tables must exist, or an error is returned.

setTableNames

public ShowTableMetadataRequest setTableNames(List<String> tableNames)

Parameters:

tableNames - Tables whose metadata will be fetched. All provided tables must exist, or an error is returned.

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