Package com.gpudb.protocol

Class 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.

    Retrieves the user provided metadata for the specified tables.

    • 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 - Names of tables whose metadata will be fetched, in [schema_name.]table_name format, using standard name resolution rules. 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()
        Names of tables whose metadata will be fetched, in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned.
        Returns:
        The current value of tableNames.

      • setTableNames

        public ShowTableMetadataRequest setTableNames​(List<String> tableNames)
        Names of tables whose metadata will be fetched, in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned.
        Parameters:
        tableNames - The new value for tableNames.
        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 ShowTableMetadataRequest 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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object