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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RawGetRecordsFromCollectionResponse.Info A set of string constants for the RawGetRecordsFromCollectionResponse parameter info.

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)
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.
Map<String,String>	getInfo() Additional information.
List<String>	getRecordIds() If the 'return_record_ids' option of the request was 'true', then this list contains the internal ID for each object.
List<ByteBuffer>	getRecordsBinary() If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection.
List<String>	getRecordsJson() If the encoding parameter of the request was 'json', then this list contains the JSON encoded records retrieved from the table/collection.
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.
List<String>	getTypeNames() The type IDs of the corresponding records in 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.
RawGetRecordsFromCollectionResponse	setInfo(Map<String,String> info) Additional information.
RawGetRecordsFromCollectionResponse	setRecordIds(List<String> recordIds) If the 'return_record_ids' option of the request was 'true', then this list contains the internal ID for each object.
RawGetRecordsFromCollectionResponse	setRecordsBinary(List<ByteBuffer> recordsBinary) If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection.
RawGetRecordsFromCollectionResponse	setRecordsJson(List<String> recordsJson) If the encoding parameter of the request was 'json', then this list contains the JSON encoded records retrieved from the table/collection.
RawGetRecordsFromCollectionResponse	setTableName(String tableName) Value of tableName.
RawGetRecordsFromCollectionResponse	setTypeNames(List<String> typeNames) The type IDs of the corresponding records in recordsBinary or recordsJson.
String	toString()

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.

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 RawGetRecordsFromCollectionResponse setTableName(String tableName)

Value of tableName.

Parameters:

tableName - The new value for tableName.

Returns:

this to mimic the builder pattern.

getTypeNames

public List<String> getTypeNames()

The type IDs of the corresponding records in recordsBinary or recordsJson. This is useful when tableName is a heterogeneous collection (collections containing tables of different types).

Returns:

The current value of typeNames.

setTypeNames

public RawGetRecordsFromCollectionResponse setTypeNames(List<String> typeNames)

The type IDs of the corresponding records in recordsBinary or recordsJson. This is useful when tableName is a heterogeneous collection (collections containing tables of different types).

Parameters:

typeNames - The new value for typeNames.

Returns:

this to mimic the builder pattern.

getRecordsBinary

public List<ByteBuffer> getRecordsBinary()

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:

The current value of recordsBinary.

setRecordsBinary

public RawGetRecordsFromCollectionResponse setRecordsBinary(List<ByteBuffer> 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.

Parameters:

recordsBinary - The new value for recordsBinary.

Returns:

this to mimic the builder pattern.

getRecordsJson

public List<String> getRecordsJson()

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:

The current value of recordsJson.

setRecordsJson

public RawGetRecordsFromCollectionResponse setRecordsJson(List<String> 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.

Parameters:

recordsJson - The new value for recordsJson.

Returns:

this to mimic the builder pattern.

getRecordIds

public List<String> getRecordIds()

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

Returns:

The current value of recordIds.

setRecordIds

public RawGetRecordsFromCollectionResponse setRecordIds(List<String> recordIds)

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

Parameters:

recordIds - The new value for recordIds.

Returns:

this to mimic the builder pattern.

getInfo

public Map<String,String> getInfo()

Additional information.

• TOTAL_NUMBER_OF_RECORDS: Total number of records.
• HAS_MORE_RECORDS: Too many records. Returned a partial set. Supported values:
  • TRUE
  • FALSE

The default value is an empty Map.

Returns:

The current value of info.

setInfo

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

Additional information.

• TOTAL_NUMBER_OF_RECORDS: Total number of records.
• HAS_MORE_RECORDS: Too many records. Returned a partial set. Supported values:
  • TRUE
  • FALSE

The default value is an empty Map.

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