com.gpudb.protocol

Class ShowTypesRequest

java.lang.Object

com.gpudb.protocol.ShowTypesRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.showTypes(ShowTypesRequest).

Retrieves information for the specified data type ID or type label. For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShowTypesRequest.Options Optional parameters.

Constructor Summary

Constructors

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowTypesRequest

public ShowTypesRequest()

Constructs a ShowTypesRequest object with default parameters.

ShowTypesRequest

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

Constructs a ShowTypesRequest object with the specified parameters.

Parameters:

typeId - Type Id returned in response to a call to GPUdb.createType(CreateTypeRequest).

label - Option string that was supplied by user in a call to GPUdb.createType(CreateTypeRequest).

options - Optional parameters.

• NO_JOIN_TYPES: When set to 'true', no join types will be included. 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.

getTypeId

public String getTypeId()

Returns:

Type Id returned in response to a call to GPUdb.createType(CreateTypeRequest).

setTypeId

public ShowTypesRequest setTypeId(String typeId)

Parameters:

typeId - Type Id returned in response to a call to GPUdb.createType(CreateTypeRequest).

Returns:

this to mimic the builder pattern.

getLabel

public String getLabel()

Returns:

Option string that was supplied by user in a call to GPUdb.createType(CreateTypeRequest).

setLabel

public ShowTypesRequest setLabel(String label)

Parameters:

label - Option string that was supplied by user in a call to GPUdb.createType(CreateTypeRequest).

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• NO_JOIN_TYPES: When set to 'true', no join types will be included. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters.

• NO_JOIN_TYPES: When set to 'true', no join types will be included. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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