Package com.gpudb.protocol

Class ShowSchemaRequest

java.lang.Object

com.gpudb.protocol.ShowSchemaRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.showSchema.

Retrieves information about a schema (or all schemas), as specified in schemaName.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ShowSchemaRequest()	Constructs a ShowSchemaRequest object with default parameters.
ShowSchemaRequest(String schemaName, Map<String,String> options)	Constructs a ShowSchemaRequest 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.
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.
String	getSchemaName()	Name of the schema for which to retrieve the information.
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.
ShowSchemaRequest	setOptions(Map<String,String> options)	Optional parameters.
ShowSchemaRequest	setSchemaName(String schemaName)	Name of the schema for which to retrieve the information.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowSchemaRequest

public ShowSchemaRequest()

Constructs a ShowSchemaRequest object with default parameters.

ShowSchemaRequest

public ShowSchemaRequest(String schemaName,
                         Map<String,String> options)

Constructs a ShowSchemaRequest object with the specified parameters.

Parameters:

schemaName - Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned.

options - Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided schemaName does not exist. If TRUE then it will return an empty result if the provided schemaName 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.

getSchemaName

public String getSchemaName()

Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned.

Returns:

The current value of schemaName.

setSchemaName

public ShowSchemaRequest setSchemaName(String schemaName)

Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned.

Parameters:

schemaName - The new value for schemaName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided schemaName does not exist. If TRUE then it will return an empty result if the provided schemaName 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 ShowSchemaRequest setOptions(Map<String,String> options)

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided schemaName does not exist. If TRUE then it will return an empty result if the provided schemaName 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