Kinetica   C#   API  Version 7.2.3.0
CreateGraph.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 {
24  {
34  public struct DirectedGraph
35  {
36  public const string TRUE = "true";
37  public const string FALSE = "false";
38  } // end struct DirectedGraph
39 
43  public struct Options
44  {
51  public const string MERGE_TOLERANCE = "merge_tolerance";
52 
67  public const string RECREATE = "recreate";
68 
69  public const string TRUE = "true";
70  public const string FALSE = "false";
71 
88  public const string SAVE_PERSIST = "save_persist";
89 
105  public const string ADD_TABLE_MONITOR = "add_table_monitor";
106 
118  public const string GRAPH_TABLE = "graph_table";
119 
134  public const string ADD_TURNS = "add_turns";
135 
147  public const string IS_PARTITIONED = "is_partitioned";
148 
153  public const string SERVER_ID = "server_id";
154 
168  public const string USE_RTREE = "use_rtree";
169 
174  public const string LABEL_DELIMITER = "label_delimiter";
175 
190  public const string ALLOW_MULTIPLE_EDGES = "allow_multiple_edges";
191 
197  public const string EMBEDDING_TABLE = "embedding_table";
198  } // end struct Options
199 
201  public string graph_name { get; set; }
202 
215  public bool directed_graph { get; set; } = true;
216 
230  public IList<string> nodes { get; set; } = new List<string>();
231 
245  public IList<string> edges { get; set; } = new List<string>();
246 
260  public IList<string> weights { get; set; } = new List<string>();
261 
276  public IList<string> restrictions { get; set; } = new List<string>();
277 
461  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
462 
465  public CreateGraphRequest() { }
466 
720  bool? directed_graph,
721  IList<string> nodes,
722  IList<string> edges,
723  IList<string> weights,
724  IList<string> restrictions,
725  IDictionary<string, string> options = null)
726  {
727  this.graph_name = graph_name ?? "";
728  this.directed_graph = directed_graph ?? true;
729  this.nodes = nodes ?? new List<string>();
730  this.edges = edges ?? new List<string>();
731  this.weights = weights ?? new List<string>();
732  this.restrictions = restrictions ?? new List<string>();
733  this.options = options ?? new Dictionary<string, string>();
734  } // end constructor
735  } // end class CreateGraphRequest
736 
741  {
743  public bool result { get; set; }
744 
746  public long num_nodes { get; set; }
747 
749  public long num_edges { get; set; }
750 
755  public IList<long> edges_ids { get; set; } = new List<long>();
756 
758  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
759  } // end class CreateGraphResponse
760 } // end namespace kinetica
IDictionary< string, string > info
Additional information.
Definition: CreateGraph.cs:758
long num_edges
Total number of edges created.
Definition: CreateGraph.cs:749
IList< string > weights
Weights represent a method of informing the graph solver of the cost of including a given edge in a s...
Definition: CreateGraph.cs:260
const string ALLOW_MULTIPLE_EDGES
Multigraph choice; allowing multiple edges with the same node pairs if set to true,...
Definition: CreateGraph.cs:190
IList< long > edges_ids
[Deprecated] Edges given as pairs of node indices.
Definition: CreateGraph.cs:755
A set of string constants for the parameter options.
Definition: CreateGraph.cs:43
const string ADD_TURNS
Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that a...
Definition: CreateGraph.cs:134
A set of string constants for the parameter directed_graph.
Definition: CreateGraph.cs:34
long num_nodes
Total number of nodes created.
Definition: CreateGraph.cs:746
const string RECREATE
If set to TRUE and the graph (using graph_name) already exists, the graph is deleted and recreated.
Definition: CreateGraph.cs:67
IList< string > nodes
Nodes represent fundamental topological units of a graph.
Definition: CreateGraph.cs:230
CreateGraphRequest()
Constructs a CreateGraphRequest object with default parameters.
Definition: CreateGraph.cs:465
CreateGraphRequest(string graph_name, bool? directed_graph, IList< string > nodes, IList< string > edges, IList< string > weights, IList< string > restrictions, IDictionary< string, string > options=null)
Constructs a CreateGraphRequest object with the specified parameters.
Definition: CreateGraph.cs:719
A set of parameters for Kinetica.createGraph.
Definition: CreateGraph.cs:23
IDictionary< string, string > options
Optional parameters.
Definition: CreateGraph.cs:461
string graph_name
Name of the graph resource to generate.
Definition: CreateGraph.cs:201
const string LABEL_DELIMITER
If provided the label string will be split according to this delimiter and each sub-string will be ap...
Definition: CreateGraph.cs:174
A set of results returned by Kinetica.createGraph.
Definition: CreateGraph.cs:740
const string MERGE_TOLERANCE
If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allo...
Definition: CreateGraph.cs:51
const string GRAPH_TABLE
If specified, the created graph is also created as a table with the given name, in [schema_name.
Definition: CreateGraph.cs:118
const string SAVE_PERSIST
If set to TRUE, the graph will be saved in the persist directory (see the config reference for more i...
Definition: CreateGraph.cs:88
IList< string > edges
Edges represent the required fundamental topological unit of a graph that typically connect nodes.
Definition: CreateGraph.cs:245
bool result
Indicates a successful creation on all servers.
Definition: CreateGraph.cs:743
const string ADD_TABLE_MONITOR
Adds a table monitor to every table used in the creation of the graph; this table monitor will trigge...
Definition: CreateGraph.cs:105
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string USE_RTREE
Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges.
Definition: CreateGraph.cs:168
bool directed_graph
If set to TRUE, the graph will be directed.
Definition: CreateGraph.cs:215
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: CreateGraph.cs:153
const string EMBEDDING_TABLE
If table exists (should be generated by the match/graph match_embedding solver), the vector embedding...
Definition: CreateGraph.cs:197
IList< string > restrictions
Restrictions represent a method of informing the graph solver which edges and/or nodes should be igno...
Definition: CreateGraph.cs:276