com.gpudb.protocol

Class RawGetRecordsFromCollectionResponse

java.lang.Object

com.gpudb.protocol.RawGetRecordsFromCollectionResponse

All Implemented Interfaces:

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

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

A set of results returned by GPUdb.getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest). The Raw version of this method can be used to specify the encoding scheme of the response.

Constructor Summary

Constructors

Constructor and Description
RawGetRecordsFromCollectionResponse() Constructs a RawGetRecordsFromCollectionResponse object with default parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) The Raw version of this method can be used to specify the encoding scheme of the response.
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>	getRecordIds() The Raw version of this method can be used to specify the encoding scheme of the response.
List<ByteBuffer>	getRecordsBinary() The Raw version of this method can be used to specify the encoding scheme of the response.
List<String>	getRecordsJson() The Raw version of this method can be used to specify the encoding scheme of the response.
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName() The Raw version of this method can be used to specify the encoding scheme of the response.
List<String>	getTypeNames() The Raw version of this method can be used to specify the encoding scheme of the response.
int	hashCode() The Raw version of this method can be used to specify the encoding scheme of the response.
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
RawGetRecordsFromCollectionResponse	setRecordIds(List<String> recordIds) The Raw version of this method can be used to specify the encoding scheme of the response.
RawGetRecordsFromCollectionResponse	setRecordsBinary(List<ByteBuffer> recordsBinary) The Raw version of this method can be used to specify the encoding scheme of the response.
RawGetRecordsFromCollectionResponse	setRecordsJson(List<String> recordsJson) The Raw version of this method can be used to specify the encoding scheme of the response.
RawGetRecordsFromCollectionResponse	setTableName(String tableName) The Raw version of this method can be used to specify the encoding scheme of the response.
RawGetRecordsFromCollectionResponse	setTypeNames(List<String> typeNames) The Raw version of this method can be used to specify the encoding scheme of the response.
String	toString() The Raw version of this method can be used to specify the encoding scheme of the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

RawGetRecordsFromCollectionResponse

public RawGetRecordsFromCollectionResponse()

Constructs a RawGetRecordsFromCollectionResponse object with default parameters. The Raw version of this method can be used to specify the encoding scheme of the response.

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. The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

the schema for the class.

getTableName

public String getTableName()

The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

Value of tableName.

setTableName

public RawGetRecordsFromCollectionResponse setTableName(String tableName)

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

tableName - Value of tableName.

Returns:

this to mimic the builder pattern.

getTypeNames

public List<String> getTypeNames()

The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

The type IDs of the corresponding records in recordsBinary or recordsJson. This is useful when tableName is a heterogeneous collection (i.e. the child tables are not all of the same type).

setTypeNames

public RawGetRecordsFromCollectionResponse setTypeNames(List<String> typeNames)

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

typeNames - The type IDs of the corresponding records in recordsBinary or recordsJson. This is useful when tableName is a heterogeneous collection (i.e. the child tables are not all of the same type).

Returns:

this to mimic the builder pattern.

getRecordsBinary

public List<ByteBuffer> getRecordsBinary()

The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection. Otherwise, empty list.

setRecordsBinary

public RawGetRecordsFromCollectionResponse setRecordsBinary(List<ByteBuffer> recordsBinary)

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

recordsBinary - If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection. Otherwise, empty list.

Returns:

this to mimic the builder pattern.

getRecordsJson

public List<String> getRecordsJson()

The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

If the encoding parameter of the request was 'json', then this list contains the JSON encoded records retrieved from the table/collection. Otherwise, empty list.

setRecordsJson

public RawGetRecordsFromCollectionResponse setRecordsJson(List<String> recordsJson)

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

recordsJson - If the encoding parameter of the request was 'json', then this list contains the JSON encoded records retrieved from the table/collection. Otherwise, empty list.

Returns:

this to mimic the builder pattern.

getRecordIds

public List<String> getRecordIds()

The Raw version of this method can be used to specify the encoding scheme of the response.

Returns:

If the 'return_record_ids' option of the request was 'true', then this list contains the internal GPUdb id for each object. Otherwise it will be empty.

setRecordIds

public RawGetRecordsFromCollectionResponse setRecordIds(List<String> recordIds)

The Raw version of this method can be used to specify the encoding scheme of the response.

Parameters:

recordIds - If the 'return_record_ids' option of the request was 'true', then this list contains the internal GPUdb id for each object. Otherwise it will be empty.

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. The Raw version of this method can be used to specify the encoding scheme of the response.

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. The Raw version of this method can be used to specify the encoding scheme of the response.

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. The Raw version of this method can be used to specify the encoding scheme of the response.

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)

The Raw version of this method can be used to specify the encoding scheme of the response.

Overrides:

equals in class Object

toString

public String toString()

The Raw version of this method can be used to specify the encoding scheme of the response.

Overrides:

toString in class Object

hashCode

public int hashCode()

The Raw version of this method can be used to specify the encoding scheme of the response.

Overrides:

hashCode in class Object