Package com.gpudb.protocol

Class CreateDirectoryRequest

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

    Creates a new directory in KiFS. The new directory serves as a location in which the user can upload files using GPUdb.uploadFiles.

    • Constructor Detail

      • CreateDirectoryRequest

        public CreateDirectoryRequest()
        Constructs a CreateDirectoryRequest object with default parameters.

      • CreateDirectoryRequest

        public CreateDirectoryRequest​(String directoryName,
                              Map<String,​String> options)
        Constructs a CreateDirectoryRequest object with the specified parameters.
        Parameters:
        directoryName - Name of the directory in KiFS to be created.
        options - Optional parameters.
        • CREATE_HOME_DIRECTORY: When set, a home directory is created for the user name provided in the value. The directoryName must be an empty string in this case. The user must exist.
        • DATA_LIMIT: The maximum capacity, in bytes, to apply to the created directory. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
        • NO_ERROR_IF_EXISTS: If TRUE, does not return an error if the directory already exists. Supported values: 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.

      • getDirectoryName

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

      • setDirectoryName

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

      • getOptions

        public Map<String,​String> getOptions()
        Optional parameters.
        • CREATE_HOME_DIRECTORY: When set, a home directory is created for the user name provided in the value. The directoryName must be an empty string in this case. The user must exist.
        • DATA_LIMIT: The maximum capacity, in bytes, to apply to the created directory. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
        • NO_ERROR_IF_EXISTS: If TRUE, does not return an error if the directory already exists. Supported values: The default value is FALSE.
        The default value is an empty Map.
        Returns:
        The current value of options.

      • setOptions

        public CreateDirectoryRequest setOptions​(Map<String,​String> options)
        Optional parameters.
        • CREATE_HOME_DIRECTORY: When set, a home directory is created for the user name provided in the value. The directoryName must be an empty string in this case. The user must exist.
        • DATA_LIMIT: The maximum capacity, in bytes, to apply to the created directory. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
        • NO_ERROR_IF_EXISTS: If TRUE, does not return an error if the directory already exists. Supported values: 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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object