Package com.gpudb.protocol

Class UploadFilesFromurlRequest

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

    Uploads one or more files to KiFS.

    Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in GPUdb.showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are delineated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.

    These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.

    • Constructor Detail

      • UploadFilesFromurlRequest

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

      • UploadFilesFromurlRequest

        public UploadFilesFromurlRequest​(List<String> fileNames,
                                 List<String> urls,
                                 Map<String,​String> options)
        Constructs an UploadFilesFromurlRequest object with the specified parameters.
        Parameters:
        fileNames - An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters.
        urls - List of URLs to upload, for each respective file in fileNames.
        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.

      • getFileNames

        public List<String> getFileNames()
        An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters.
        Returns:
        The current value of fileNames.

      • setFileNames

        public UploadFilesFromurlRequest setFileNames​(List<String> fileNames)
        An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters.
        Parameters:
        fileNames - The new value for fileNames.
        Returns:
        this to mimic the builder pattern.

      • getUrls

        public List<String> getUrls()
        List of URLs to upload, for each respective file in fileNames.
        Returns:
        The current value of urls.

      • setUrls

        public UploadFilesFromurlRequest setUrls​(List<String> urls)
        List of URLs to upload, for each respective file in fileNames.
        Parameters:
        urls - The new value for urls.
        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 UploadFilesFromurlRequest 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