Package com.gpudb.protocol

Class AlterTableMetadataRequest

  • All Implemented Interfaces:
    org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
    public class AlterTableMetadataRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
    A set of parameters for GPUdb.alterTableMetadata.

    Updates (adds or changes) metadata for tables. The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.

    • Constructor Detail

      • AlterTableMetadataRequest

        public AlterTableMetadataRequest()
        Constructs an AlterTableMetadataRequest object with default parameters.

      • AlterTableMetadataRequest

        public AlterTableMetadataRequest​(List<String> tableNames,
                                 Map<String,​String> metadataMap,
                                 Map<String,​String> options)
        Constructs an AlterTableMetadataRequest object with the specified parameters.
        Parameters:
        tableNames - Names of the tables whose metadata will be updated, in [schema_name.]table_name format, using standard name resolution rules. All specified tables must exist, or an error will be returned.
        metadataMap - A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
        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 the tables whose metadata will be updated, in [schema_name.]table_name format, using standard name resolution rules. All specified tables must exist, or an error will be returned.
        Returns:
        The current value of tableNames.

      • setTableNames

        public AlterTableMetadataRequest setTableNames​(List<String> tableNames)
        Names of the tables whose metadata will be updated, in [schema_name.]table_name format, using standard name resolution rules. All specified tables must exist, or an error will be returned.
        Parameters:
        tableNames - The new value for tableNames.
        Returns:
        this to mimic the builder pattern.

      • getMetadataMap

        public Map<String,​String> getMetadataMap()
        A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
        Returns:
        The current value of metadataMap.

      • setMetadataMap

        public AlterTableMetadataRequest setMetadataMap​(Map<String,​String> metadataMap)
        A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
        Parameters:
        metadataMap - The new value for metadataMap.
        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 AlterTableMetadataRequest 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