Class AlterDirectoryRequest

  • All Implemented Interfaces:
    org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

    public class AlterDirectoryRequest
    extends Object
    implements org.apache.avro.generic.IndexedRecord
    A set of parameters for GPUdb.alterDirectory.

    Alters an existing directory in KiFS.

    • Constructor Detail

      • AlterDirectoryRequest

        public AlterDirectoryRequest()
        Constructs an AlterDirectoryRequest object with default parameters.
      • AlterDirectoryRequest

        public AlterDirectoryRequest​(String directoryName,
                                     Map<String,​String> directoryUpdatesMap,
                                     Map<String,​String> options)
        Constructs an AlterDirectoryRequest object with the specified parameters.
        Parameters:
        directoryName - Name of the directory in KiFS to be altered.
        directoryUpdatesMap - Map containing the properties of the directory to be altered. Error if empty.
        • DATA_LIMIT: The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.
        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.
      • getDirectoryName

        public String getDirectoryName()
        Name of the directory in KiFS to be altered.
        Returns:
        The current value of directoryName.
      • setDirectoryName

        public AlterDirectoryRequest setDirectoryName​(String directoryName)
        Name of the directory in KiFS to be altered.
        Parameters:
        directoryName - The new value for directoryName.
        Returns:
        this to mimic the builder pattern.
      • getDirectoryUpdatesMap

        public Map<String,​String> getDirectoryUpdatesMap()
        Map containing the properties of the directory to be altered. Error if empty.
        • DATA_LIMIT: The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.
        Returns:
        The current value of directoryUpdatesMap.
      • setDirectoryUpdatesMap

        public AlterDirectoryRequest setDirectoryUpdatesMap​(Map<String,​String> directoryUpdatesMap)
        Map containing the properties of the directory to be altered. Error if empty.
        • DATA_LIMIT: The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.
        Parameters:
        directoryUpdatesMap - The new value for directoryUpdatesMap.
        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 AlterDirectoryRequest 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