Kinetica   C#   API  Version 7.2.3.1
GetGraphEntities.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica;
10 
19 {
23  public struct Options
24  {
40  public const string ENTITY_TYPE = "entity_type";
41 
43  public const string EDGE = "edge";
44 
46  public const string NODE = "node";
47 
52  public const string SERVER_ID = "server_id";
53 
77  public const string CONCISE_EDGE_CONNECTIVITY = "concise_edge_connectivity";
78 
82  public const string TRUE = "true";
83 
87  public const string FALSE = "false";
88 
115  public const string INCLUDE_WEIGHTS = "include_weights";
116  } // end struct Options
117 
119  public string graph_name { get; set; }
120 
124  public long offset { get; set; } = 0;
125 
134  public long limit { get; set; } = 10000;
135 
232  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
233 
237 
349  long? offset = null,
350  long? limit = null,
351  IDictionary<string, string> options = null)
352  {
353  this.graph_name = graph_name ?? "";
354  this.offset = offset ?? 0;
355  this.limit = limit ?? 10000;
356  this.options = options ?? new Dictionary<string, string>();
357  } // end constructor
358 } // end class GetGraphEntitiesRequest
359 
364 {
366  public bool result { get; set; }
367 
380  public IList<long> entities_int { get; set; } = new List<long>();
381 
393  public IList<string> entities_string { get; set; } = new List<string>();
394 
407  public IList<double> entities_double { get; set; } = new List<double>();
408 
418  public IList<float> entities_weight { get; set; } = new List<float>();
419 
425  public IList<string> labels { get; set; } = new List<string>();
426 
450  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
451 } // end class GetGraphEntitiesResponse
GetGraphEntitiesRequest(string graph_name, long? offset=null, long? limit=null, IDictionary< string, string > options=null)
Constructs a GetGraphEntitiesRequest object with the specified parameters.
IList< float > entities_weight
Per-edge weight values, populated only when the request option 'include_weights' is 'true' and option...
A set of parameters for Kinetica.getGraphEntities.
const string FALSE
Default: entities_weight is empty.
IList< string > entities_string
Flat array of entity data for name-identifier (string) graphs only.
const string EDGE
Retrieve edge entities (default).
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string ENTITY_TYPE
The type of entity to retrieve.
long offset
Starting index of the entities to retrieve (0-based).
bool result
Indicates a successful retrieval.
const string NODE
Retrieve node entities.
A set of results returned by Kinetica.getGraphEntities.
IDictionary< string, string > options
Optional parameters.
IList< double > entities_double
Compact double-packed payload for WKT (geo/XY) graphs.
IList< long > entities_int
Flat array of entity data for integer-identifier graphs with a repeating stride.
IList< string > labels
Array of distinct label strings.
IDictionary< string, string > info
Additional information map.
string graph_name
Name of the graph from which to retrieve entities.
const string SERVER_ID
Indicates which graph server to send the request to.
const string TRUE
Populate entities_weight with per-edge weights (edge requests only).
A set of string constants for the parameter options.
GetGraphEntitiesRequest()
Constructs a GetGraphEntitiesRequest object with default parameters.
const string CONCISE_EDGE_CONNECTIVITY
When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type...
const string INCLUDE_WEIGHTS
When true and options entity_type is 'edge', the response entities_weight array is populated with one...
long limit
Number of entities to retrieve starting from offset.