Kinetica   C#   API  Version 7.2.3.0
kinetica.RawGetRecordsFromCollectionResponse Class Reference

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

+ Inheritance diagram for kinetica.RawGetRecordsFromCollectionResponse:
+ Collaboration diagram for kinetica.RawGetRecordsFromCollectionResponse:

Classes

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

Properties

string table_name [get, set]
 Value of table_name. More...
 
IList< string > type_names = new List<string>() [get, set]
 The type IDs of the corresponding records in records_binary or records_json. More...
 
IList< byte[]> records_binary = new List<byte[]>() [get, set]
 If the encoding parameter of the request was 'binary' then this list contains the binary encoded records retrieved from the table/collection. More...
 
IList< string > records_json = new List<string>() [get, set]
 If the encoding parameter of the request was 'json', then this list contains the JSON encoded records retrieved from the table/collection. More...
 
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. More...
 
IDictionary< string, string > info = new Dictionary<string, string>() [get, set]
 Additional information. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 
- 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. More...
 

Detailed Description

A set of results returned by Kinetica.getRecordsFromCollection.

Definition at line 287 of file GetRecordsFromCollection.cs.

Property Documentation

◆ info

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

Additional information.

The default value is an empty Dictionary.

Definition at line 368 of file GetRecordsFromCollection.cs.

◆ record_ids

IList<string> kinetica.RawGetRecordsFromCollectionResponse.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 342 of file GetRecordsFromCollection.cs.

◆ records_binary

IList<byte[]> kinetica.RawGetRecordsFromCollectionResponse.records_binary = new List<byte[]>()
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 330 of file GetRecordsFromCollection.cs.

◆ records_json

IList<string> kinetica.RawGetRecordsFromCollectionResponse.records_json = new List<string>()
getset

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.

Definition at line 336 of file GetRecordsFromCollection.cs.

◆ table_name

string kinetica.RawGetRecordsFromCollectionResponse.table_name
getset

Value of table_name.

Definition at line 316 of file GetRecordsFromCollection.cs.

◆ type_names

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

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

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

Definition at line 324 of file GetRecordsFromCollection.cs.


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