Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
10 
11 namespace kinetica
12 {
13 
31  {
32 
52  public struct DirectedGraph
53  {
54  public const string TRUE = "true";
55  public const string FALSE = "false";
56  } // end struct DirectedGraph
57 
58 
248  public struct Options
249  {
250 
256  public const string MERGE_TOLERANCE = "merge_tolerance";
257 
274  public const string RECREATE = "recreate";
275  public const string TRUE = "true";
276  public const string FALSE = "false";
277 
297  public const string SAVE_PERSIST = "save_persist";
298 
321  public const string ADD_TABLE_MONITOR = "add_table_monitor";
322 
333  public const string GRAPH_TABLE = "graph_table";
334 
352  public const string ADD_TURNS = "add_turns";
353 
368  public const string IS_PARTITIONED = "is_partitioned";
369 
373  public const string SERVER_ID = "server_id";
374 
390  public const string USE_RTREE = "use_rtree";
391 
396  public const string LABEL_DELIMITER = "label_delimiter";
397 
414  public const string ALLOW_MULTIPLE_EDGES = "allow_multiple_edges";
415  } // end struct Options
416 
417 
419  public string graph_name { get; set; }
420 
439  public bool directed_graph { get; set; } = true;
440 
456  public IList<string> nodes { get; set; } = new List<string>();
457 
474  public IList<string> edges { get; set; } = new List<string>();
475 
494  public IList<string> weights { get; set; } = new List<string>();
495 
512  public IList<string> restrictions { get; set; } = new List<string>();
513 
701  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
702 
703 
706  public CreateGraphRequest() { }
707 
987  bool? directed_graph,
988  IList<string> nodes,
989  IList<string> edges,
990  IList<string> weights,
991  IList<string> restrictions,
992  IDictionary<string, string> options = null)
993  {
994  this.graph_name = graph_name ?? "";
995  this.directed_graph = directed_graph ?? true;
996  this.nodes = nodes ?? new List<string>();
997  this.edges = edges ?? new List<string>();
998  this.weights = weights ?? new List<string>();
999  this.restrictions = restrictions ?? new List<string>();
1000  this.options = options ?? new Dictionary<string, string>();
1001  } // end constructor
1002 
1003  } // end class CreateGraphRequest
1004 
1005 
1006 
1011  {
1012 
1015  public bool result { get; set; }
1016 
1018  public long num_nodes { get; set; }
1019 
1021  public long num_edges { get; set; }
1022 
1026  public IList<long> edges_ids { get; set; } = new List<long>();
1027 
1029  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1030 
1031  } // end class CreateGraphResponse
1032 
1033 
1034 
1035 
1036 } // end namespace kinetica
IDictionary< string, string > info
Additional information.
long num_edges
Total number of edges created.
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:494
const string ALLOW_MULTIPLE_EDGES
Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted.
Definition: CreateGraph.cs:414
IList< long > edges_ids
[Deprecated] Edges given as pairs of node indices.
const string ADD_TURNS
Adds dummy &#39;pillowed&#39; edges around intersection nodes where there are more than three edges so that a...
Definition: CreateGraph.cs:352
If set to true, the graph will be directed.
Definition: CreateGraph.cs:52
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:986
long num_nodes
Total number of nodes created.
const string RECREATE
If set to true and the graph (using graph_name) already exists, the graph is deleted and recreated...
Definition: CreateGraph.cs:274
IList< string > nodes
Nodes represent fundamental topological units of a graph.
Definition: CreateGraph.cs:456
CreateGraphRequest()
Constructs a CreateGraphRequest object with default parameters.
Definition: CreateGraph.cs:706
A set of parameters for Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}).
Definition: CreateGraph.cs:30
IDictionary< string, string > options
Optional parameters.
Definition: CreateGraph.cs:701
string graph_name
Name of the graph resource to generate.
Definition: CreateGraph.cs:419
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:396
A set of results returned by Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}).
const string MERGE_TOLERANCE
If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allo...
Definition: CreateGraph.cs:256
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:333
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:297
IList< string > edges
Edges represent the required fundamental topological unit of a graph that typically connect nodes...
Definition: CreateGraph.cs:474
bool result
Indicates a successful creation on all servers.
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:321
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string IS_PARTITIONED
Supported values: TRUE FALSE The default value is FALSE.
Definition: CreateGraph.cs:368
const string USE_RTREE
Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges...
Definition: CreateGraph.cs:390
bool directed_graph
If set to true, the graph will be directed.
Definition: CreateGraph.cs:439
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: CreateGraph.cs:373
IList< string > restrictions
Restrictions represent a method of informing the graph solver which edges and/or nodes should be igno...
Definition: CreateGraph.cs:512