Skip to main content
Package 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.

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.

  • ​
    Constructor Details

    • ​
      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.
      label - Option string that was supplied by user in a call to GPUdb.createType.
      options - Optional parameters.The default value is an empty Map.

  • ​
    Method Details

    • ​
      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()
      Type Id returned in response to a call to GPUdb.createType.
      Returns:
      The current value of typeId.

    • ​
      setTypeId

      public ShowTypesRequest setTypeId(String typeId)
      Type Id returned in response to a call to GPUdb.createType.
      Parameters:
      typeId - The new value for typeId.
      Returns:
      this to mimic the builder pattern.

    • ​
      getLabel

      public String getLabel()
      Option string that was supplied by user in a call to GPUdb.createType.
      Returns:
      The current value of label.

    • ​
      setLabel

      public ShowTypesRequest setLabel(String label)
      Option string that was supplied by user in a call to GPUdb.createType.
      Parameters:
      label - The new value for label.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      Optional parameters.The default value is an empty Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public ShowTypesRequest setOptions(Map<String,String> options)
      Optional parameters.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