com.gpudb.protocol

Class DownloadFilesRequest

java.lang.Object

com.gpudb.protocol.DownloadFilesRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class DownloadFilesRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.downloadFiles(DownloadFilesRequest).

Downloads one or more files from KiFS.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DownloadFilesRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
DownloadFilesRequest() Constructs a DownloadFilesRequest object with default parameters.
DownloadFilesRequest(List<String> fileNames, List<Long> readOffsets, List<Long> readLengths, Map<String,String> options) Constructs a DownloadFilesRequest 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()
List<Long>	getReadLengths()
List<Long>	getReadOffsets()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
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.
DownloadFilesRequest	setFileNames(List<String> fileNames)
DownloadFilesRequest	setOptions(Map<String,String> options)
DownloadFilesRequest	setReadLengths(List<Long> readLengths)
DownloadFilesRequest	setReadOffsets(List<Long> readOffsets)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadFilesRequest

public DownloadFilesRequest()

Constructs a DownloadFilesRequest object with default parameters.

DownloadFilesRequest

public DownloadFilesRequest(List<String> fileNames,
                            List<Long> readOffsets,
                            List<Long> readLengths,
                            Map<String,String> options)

Constructs a DownloadFilesRequest object with the specified parameters.

Parameters:

fileNames - An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.

readOffsets - An array of starting byte offsets from which to read each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readLengths must also not be empty.

readLengths - Array of number of bytes to read from each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readOffsets must also not be empty.

options - Optional parameters.

• FILE_ENCODING: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values:
  • BASE64: Apply base64 encoding to the output file data.
  • NONE: Do not apply any encoding to the output file data.
  The default value is NONE.

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 the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.

setFileNames

public DownloadFilesRequest setFileNames(List<String> fileNames)

Parameters:

fileNames - An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.

Returns:

this to mimic the builder pattern.

getReadOffsets

public List<Long> getReadOffsets()

Returns:

An array of starting byte offsets from which to read each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readLengths must also not be empty.

setReadOffsets

public DownloadFilesRequest setReadOffsets(List<Long> readOffsets)

Parameters:

readOffsets - An array of starting byte offsets from which to read each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readLengths must also not be empty.

Returns:

this to mimic the builder pattern.

getReadLengths

public List<Long> getReadLengths()

Returns:

Array of number of bytes to read from each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readOffsets must also not be empty.

setReadLengths

public DownloadFilesRequest setReadLengths(List<Long> readLengths)

Parameters:

readLengths - Array of number of bytes to read from each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readOffsets must also not be empty.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• FILE_ENCODING: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values:
  • BASE64: Apply base64 encoding to the output file data.
  • NONE: Do not apply any encoding to the output file data.
  The default value is NONE.

The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters.

• FILE_ENCODING: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values:
  • BASE64: Apply base64 encoding to the output file data.
  • NONE: Do not apply any encoding to the output file data.
  The default value is NONE.

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