com.gpudb.protocol

Class UploadFilesFromurlRequest

java.lang.Object

com.gpudb.protocol.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(UploadFilesFromurlRequest).

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(ShowDirectoriesRequest). The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated 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 Summary

Constructors

Constructor and Description
UploadFilesFromurlRequest() Constructs an UploadFilesFromurlRequest object with default parameters.
UploadFilesFromurlRequest(List<String> fileNames, List<String> urls, Map<String,String> options) Constructs an UploadFilesFromurlRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<String>	getFileNames()
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<String>	getUrls()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
UploadFilesFromurlRequest	setFileNames(List<String> fileNames)
UploadFilesFromurlRequest	setOptions(Map<String,String> options)
UploadFilesFromurlRequest	setUrls(List<String> urls)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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()

Returns:

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.

setFileNames

public UploadFilesFromurlRequest setFileNames(List<String> fileNames)

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.

Returns:

this to mimic the builder pattern.

getUrls

public List<String> getUrls()

Returns:

List of URLs to upload, for each respective file in fileNames.

setUrls

public UploadFilesFromurlRequest setUrls(List<String> urls)

Parameters:

urls - List of URLs to upload, for each respective file in fileNames.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters. The default value is an empty Map.

setOptions

public UploadFilesFromurlRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters. The default value is an empty Map.

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object