Package com.gpudb.protocol
Class RawGetRecordsFromCollectionResponse
java.lang.Object
com.gpudb.protocol.RawGetRecordsFromCollectionResponse
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecordpublic class RawGetRecordsFromCollectionResponse extends Object implements org.apache.avro.generic.IndexedRecord
A set of results returned by
GPUdb.getRecordsFromCollectionRaw.Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theRawGetRecordsFromCollectionResponseparameterinfo.Constructor Summary
ConstructorsConstructorDescriptionConstructs a RawGetRecordsFromCollectionResponse object with default parameters.Method Summary
Modifier and TypeMethodDescriptionbooleanget(int index) This method supports the Avro framework and is not intended to be called directly by the user.static org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.getInfo()Additional information.If the ‘return_record_ids’ option of the request was ‘true’, then this list contains the internal ID for each object.If the encoding parameter of the request was ‘binary’ then this list contains the binary encoded records retrieved from the table/collection.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.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.Value oftableName.The type IDs of the corresponding records inrecordsBinaryorrecordsJson.inthashCode()voidThis method supports the Avro framework and is not intended to be called directly by the user.Additional information.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.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.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.setTableName(String tableName) Value oftableName.setTypeNames(List<String> typeNames) The type IDs of the corresponding records inrecordsBinaryorrecordsJson.toString()
Method Details
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.setTableName
Value oftableName.Parameters:tableName- The new value fortableName.Returns:thisto mimic the builder pattern.getTypeNames
The type IDs of the corresponding records inrecordsBinaryorrecordsJson. This is useful whentableNameis a heterogeneous collection (collections containing tables of different types).Returns:The current value oftypeNames.setTypeNames
The type IDs of the corresponding records inrecordsBinaryorrecordsJson. This is useful whentableNameis a heterogeneous collection (collections containing tables of different types).Parameters:typeNames- The new value fortypeNames.Returns:thisto mimic the builder pattern.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 ofrecordsBinary.setRecordsBinary
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 forrecordsBinary.Returns:thisto mimic the builder pattern.setRecordsJson
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 forrecordsJson.Returns:thisto mimic the builder pattern.setRecordIds
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 forrecordIds.Returns:thisto mimic the builder pattern.getInfo
Additional information.TOTAL_NUMBER_OF_RECORDS: Total number of records.HAS_MORE_RECORDS: Too many records. Returned a partial set. Supported values:
Map.Returns:The current value ofinfo.setInfo
Additional information.TOTAL_NUMBER_OF_RECORDS: Total number of records.HAS_MORE_RECORDS: Too many records. Returned a partial set. Supported values:
Map.Parameters:info- The new value forinfo.Returns:thisto 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:getSchemain interfaceorg.apache.avro.generic.GenericContainerReturns:The schema object describing this class.get
This method supports the Avro framework and is not intended to be called directly by the user.Specified by:getin interfaceorg.apache.avro.generic.IndexedRecordParameters:index- the position of the field to getReturns:value of the field with the given index.Throws:put
This method supports the Avro framework and is not intended to be called directly by the user.Specified by:putin interfaceorg.apache.avro.generic.IndexedRecordParameters:index- the position of the field to setvalue- the value to setThrows: