Kinetica   C#   API  Version 7.2.3.0
kinetica.GetGraphEntitiesResponse Class Reference

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

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

Properties

bool result [get, set]
 Indicates a successful retrieval. More...
 
IList< long > entities_int = new List<long>() [get, set]
 Flat array of entity data for integer-identifier graphs with a repeating stride. More...
 
IList< string > entities_string = new List<string>() [get, set]
 Flat array of entity data for name-identifier or WKT-identifier (geo/XY) graphs with a repeating stride. More...
 
IList< string > labels = new List<string>() [get, set]
 Array of distinct label strings. More...
 
IDictionary< string, string > info = new Dictionary<string, string>() [get, set]
 Additional information map. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 
- Properties inherited from Avro.Specific.ISpecificRecord
Schema Schema [get]
 

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...
 
 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...
 
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.getGraphEntities.

Definition at line 169 of file GetGraphEntities.cs.

Property Documentation

◆ entities_int

IList<long> kinetica.GetGraphEntitiesResponse.entities_int = new List<long>()
getset

Flat array of entity data for integer-identifier graphs with a repeating stride.

For node entities (stride 2): [node_id, label_index, ...]. For edge entities (stride 4): [edge_id, node1_id, node2_id, label_index, ...]. Populated when the graph uses integer identifiers; empty otherwise. The label_index is a 1-based index into the labels array; 0 indicates no label.

Definition at line 182 of file GetGraphEntities.cs.

◆ entities_string

IList<string> kinetica.GetGraphEntitiesResponse.entities_string = new List<string>()
getset

Flat array of entity data for name-identifier or WKT-identifier (geo/XY) graphs with a repeating stride.

For node entities (stride 2): [node_name, label_index, ...] or [wkt_point, label_index, ...]. For edge entities (stride 4): [edge_id, node1_name, node2_name, label_index, ...] or [edge_id, node1_wkt, node2_wkt, label_index, ...]. Populated when the graph uses string/name identifiers or geo/XY coordinate identifiers; empty otherwise. For geo/XY graphs, node identifiers are formatted as 'POINT(x y)' WKT strings. The label_index is a string representation of a 1-based index into the labels array; '0' indicates no label.

Definition at line 196 of file GetGraphEntities.cs.

◆ info

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

Additional information map.

Contains the following keys: 'identifier_type' — set to 'int' (integer node IDs in entities_int), 'string' (name-based node IDs in entities_string), or 'wkt' (geo/XY graph with 'POINT(x y)' node identifiers in entities_string). 'total_count' — total number of live (non-deleted) entities available in the graph for the requested entity_type, used for pagination. 'status_message' — set to 'Cancelled' if the request was cancelled mid-iteration (with result set to false).

Definition at line 214 of file GetGraphEntities.cs.

◆ labels

IList<string> kinetica.GetGraphEntitiesResponse.labels = new List<string>()
getset

Array of distinct label strings.

The label_index values in entities_int or entities_string are 1-based indexes into this array; index 0 means no label.

Definition at line 202 of file GetGraphEntities.cs.

◆ result

bool kinetica.GetGraphEntitiesResponse.result
getset

Indicates a successful retrieval.

Definition at line 172 of file GetGraphEntities.cs.


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