Skip to main content

A set of results returned by Kinetica.getRecordsFromCollection. More…

Inheritance diagram for kinetica.GetRecordsFromCollectionResponse< T >:
[legend]
Collaboration diagram for kinetica.GetRecordsFromCollectionResponse< T >:
[legend]

​
Classes

struct  Info
 A set of string constants for the parameter RawGetRecordsFromCollectionResponse.info. More…
 

​
Static Public Attributes

const string TOTAL_NUMBER_OF_RECORDS = “total_number_of_records”
 Total number of records.
 
const string HAS_MORE_RECORDS = “has_more_records”
 Too many records.
 
const string TRUE = “true”
 A boolean constant for the RawGetRecordsFromCollectionResponse.Info options.
 
const string FALSE = “false”
 A boolean constant for the RawGetRecordsFromCollectionResponse.Info options.
 

​
Properties

string table_name [get, set]
 Value of table_name.
 
IList< string > type_names = new List<string>() [get, set]
 The type IDs of the corresponding records in RawGetRecordsFromCollectionResponse.records_binary or records_json.
 
IList< T > data = new List<T>() [get, set]
 If the encoding parameter of the request was ‘binary’ then this list contains the binary encoded records retrieved from the table/collection.
 
IList< string > record_ids = new List<string>() [get, set]
 If the ‘return_record_ids’ option of the request was ‘true’, then this list contains the internal ID for each object.
 
IDictionary< string, string > info = new Dictionary<string, string>() [get, set]
 Additional information.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
Additional Inherited Members

 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of results returned by Kinetica.getRecordsFromCollection.

Template Parameters
TThe type of object being processed.

Definition at line 443 of file GetRecordsFromCollection.cs.

​
Member Data Documentation

​
◆ FALSE

const string kinetica.GetRecordsFromCollectionResponse< T >.FALSE = “false”
 static

A boolean constant for the RawGetRecordsFromCollectionResponse.Info options.

Definition at line 478 of file GetRecordsFromCollection.cs.

​
◆ HAS_MORE_RECORDS

const string kinetica.GetRecordsFromCollectionResponse< T >.HAS_MORE_RECORDS = “has_more_records”
 static

Too many records.

Returned a partial set. Supported values:

Definition at line 468 of file GetRecordsFromCollection.cs.

​
◆ TOTAL_NUMBER_OF_RECORDS

const string kinetica.GetRecordsFromCollectionResponse< T >.TOTAL_NUMBER_OF_RECORDS = “total_number_of_records”
 static

Total number of records.

Definition at line 451 of file GetRecordsFromCollection.cs.

​
◆ TRUE

const string kinetica.GetRecordsFromCollectionResponse< T >.TRUE = “true”
 static

A boolean constant for the RawGetRecordsFromCollectionResponse.Info options.

Definition at line 473 of file GetRecordsFromCollection.cs.

​
Property Documentation

​
◆ data

IList<T> kinetica.GetRecordsFromCollectionResponse< T >.data = new List<T>()
 getset

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.

Definition at line 499 of file GetRecordsFromCollection.cs.

​
◆ info

IDictionary<string, string> kinetica.GetRecordsFromCollectionResponse< T >.info = new Dictionary<string, string>()
 getset

Additional information.

The default value is an empty Dictionary.

Definition at line 535 of file GetRecordsFromCollection.cs.

​
◆ record_ids

IList<string> kinetica.GetRecordsFromCollectionResponse< T >.record_ids = new List<string>()
 getset

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.

Definition at line 504 of file GetRecordsFromCollection.cs.

​
◆ table_name

string kinetica.GetRecordsFromCollectionResponse< T >.table_name
 getset

Value of table_name.

Definition at line 484 of file GetRecordsFromCollection.cs.

​
◆ type_names

IList<string> kinetica.GetRecordsFromCollectionResponse< T >.type_names = new List<string>()
 getset

The type IDs of the corresponding records in RawGetRecordsFromCollectionResponse.records_binary or records_json.

This is useful when table_name is a heterogeneous collection (collections containing tables of different types).

Definition at line 493 of file GetRecordsFromCollection.cs.

The documentation for this class was generated from the following files: