Package com.gpudb.protocol

Class RawGetRecordsResponse

java.lang.Object

com.gpudb.protocol.RawGetRecordsResponse

All Implemented Interfaces:

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

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

A set of results returned by GPUdb.getRecordsRaw.

Constructor Summary

Constructors

Constructor	Description
RawGetRecordsResponse()	Constructs a RawGetRecordsResponse object with default parameters.

Method Summary

Modifier and Type	Method	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.
boolean	getHasMoreRecords()	Too many records.
Map<String,String>	getInfo()	Additional information.
List<ByteBuffer>	getRecordsBinary()	If the encoding was 'binary', then this list contains the binary encoded records retrieved from the table, otherwise not populated.
List<String>	getRecordsJson()	If the encoding was 'json', then this list contains the JSON encoded records retrieved from the table.
org.apache.avro.Schema	getSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName()	Value of tableName.
long	getTotalNumberOfRecords()	Total/Filtered number of records.
String	getTypeName()
String	getTypeSchema()	Avro schema of recordsBinary or recordsJson
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.
RawGetRecordsResponse	setHasMoreRecords(boolean hasMoreRecords)	Too many records.
RawGetRecordsResponse	setInfo(Map<String,String> info)	Additional information.
RawGetRecordsResponse	setRecordsBinary(List<ByteBuffer> recordsBinary)	If the encoding was 'binary', then this list contains the binary encoded records retrieved from the table, otherwise not populated.
RawGetRecordsResponse	setRecordsJson(List<String> recordsJson)	If the encoding was 'json', then this list contains the JSON encoded records retrieved from the table.
RawGetRecordsResponse	setTableName(String tableName)	Value of tableName.
RawGetRecordsResponse	setTotalNumberOfRecords(long totalNumberOfRecords)	Total/Filtered number of records.
RawGetRecordsResponse	setTypeName(String typeName)
RawGetRecordsResponse	setTypeSchema(String typeSchema)	Avro schema of recordsBinary or recordsJson
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RawGetRecordsResponse

public RawGetRecordsResponse()

Constructs a RawGetRecordsResponse object with default parameters.

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.

getTableName

public String getTableName()

Value of tableName.

Returns:

The current value of tableName.

setTableName

public RawGetRecordsResponse setTableName(String tableName)

Value of tableName.

Parameters:

tableName - The new value for tableName.

Returns:

this to mimic the builder pattern.

getTypeName

public String getTypeName()

Returns:

The current value of typeName.

setTypeName

public RawGetRecordsResponse setTypeName(String typeName)

Parameters:

typeName - The new value for typeName.

Returns:

this to mimic the builder pattern.

getTypeSchema

public String getTypeSchema()

Avro schema of recordsBinary or recordsJson

Returns:

The current value of typeSchema.

setTypeSchema

public RawGetRecordsResponse setTypeSchema(String typeSchema)

Avro schema of recordsBinary or recordsJson

Parameters:

typeSchema - The new value for typeSchema.

Returns:

this to mimic the builder pattern.

getRecordsBinary

public List<ByteBuffer> getRecordsBinary()

If the encoding was 'binary', then this list contains the binary encoded records retrieved from the table, otherwise not populated.

Returns:

The current value of recordsBinary.

setRecordsBinary

public RawGetRecordsResponse setRecordsBinary(List<ByteBuffer> recordsBinary)

If the encoding was 'binary', then this list contains the binary encoded records retrieved from the table, otherwise not populated.

Parameters:

recordsBinary - The new value for recordsBinary.

Returns:

this to mimic the builder pattern.

getRecordsJson

public List<String> getRecordsJson()

If the encoding was 'json', then this list contains the JSON encoded records retrieved from the table. If the encoding was 'geojson' this list contains a single entry consisting of a GeoJSON FeatureCollection containing a feature per record. Otherwise not populated.

Returns:

The current value of recordsJson.

setRecordsJson

public RawGetRecordsResponse setRecordsJson(List<String> recordsJson)

If the encoding was 'json', then this list contains the JSON encoded records retrieved from the table. If the encoding was 'geojson' this list contains a single entry consisting of a GeoJSON FeatureCollection containing a feature per record. Otherwise not populated.

Parameters:

recordsJson - The new value for recordsJson.

Returns:

this to mimic the builder pattern.

getTotalNumberOfRecords

public long getTotalNumberOfRecords()

Total/Filtered number of records.

Returns:

The current value of totalNumberOfRecords.

setTotalNumberOfRecords

public RawGetRecordsResponse setTotalNumberOfRecords(long totalNumberOfRecords)

Total/Filtered number of records.

Parameters:

totalNumberOfRecords - The new value for totalNumberOfRecords.

Returns:

this to mimic the builder pattern.

getHasMoreRecords

public boolean getHasMoreRecords()

Too many records. Returned a partial set.

Returns:

The current value of hasMoreRecords.

setHasMoreRecords

public RawGetRecordsResponse setHasMoreRecords(boolean hasMoreRecords)

Too many records. Returned a partial set.

Parameters:

hasMoreRecords - The new value for hasMoreRecords.

Returns:

this to mimic the builder pattern.

getInfo

public Map<String,String> getInfo()

Additional information.

Returns:

The current value of info.

setInfo

public RawGetRecordsResponse setInfo(Map<String,String> info)

Additional information.

Parameters:

info - The new value for info.

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