Kinetica   C#   API  Version 7.2.3.1
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 {
33  public struct DirectedGraph
34  {
35  public const string TRUE = "true";
36  public const string FALSE = "false";
37  } // end struct DirectedGraph
38 
42  public struct Options
43  {
50  public const string MERGE_TOLERANCE = "merge_tolerance";
51 
66  public const string RECREATE = "recreate";
67 
68  public const string TRUE = "true";
69  public const string FALSE = "false";
70 
86  public const string SAVE_PERSIST = "save_persist";
87 
102  public const string ADD_TABLE_MONITOR = "add_table_monitor";
103 
114  public const string GRAPH_TABLE = "graph_table";
115 
130  public const string ADD_TURNS = "add_turns";
131 
143  public const string IS_PARTITIONED = "is_partitioned";
144 
149  public const string SERVER_ID = "server_id";
150 
164  public const string USE_RTREE = "use_rtree";
165 
170  public const string LABEL_DELIMITER = "label_delimiter";
171 
186  public const string ALLOW_MULTIPLE_EDGES = "allow_multiple_edges";
187 
192  public const string EMBEDDING_TABLE = "embedding_table";
193  } // end struct Options
194 
196  public string graph_name { get; set; }
197 
210  public bool directed_graph { get; set; } = true;
211 
224  public IList<string> nodes { get; set; } = new List<string>();
225 
238  public IList<string> edges { get; set; } = new List<string>();
239 
252  public IList<string> weights { get; set; } = new List<string>();
253 
266  public IList<string> restrictions { get; set; } = new List<string>();
267 
447  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
448 
451  public CreateGraphRequest() { }
452 
701  bool? directed_graph,
702  IList<string> nodes,
703  IList<string> edges,
704  IList<string> weights,
705  IList<string> restrictions,
706  IDictionary<string, string> options = null)
707  {
708  this.graph_name = graph_name ?? "";
709  this.directed_graph = directed_graph ?? true;
710  this.nodes = nodes ?? new List<string>();
711  this.edges = edges ?? new List<string>();
712  this.weights = weights ?? new List<string>();
713  this.restrictions = restrictions ?? new List<string>();
714  this.options = options ?? new Dictionary<string, string>();
715  } // end constructor
716 } // end class CreateGraphRequest
717 
722 {
724  public bool result { get; set; }
725 
727  public long num_nodes { get; set; }
728 
730  public long num_edges { get; set; }
731 
735  public IList<long> edges_ids { get; set; } = new List<long>();
736 
738  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
739 } // end class CreateGraphResponse
const string EMBEDDING_TABLE
If table exists (should be generated by the match/graph match_embedding solver), the vector embedding...
Definition: CreateGraph.cs:192
bool result
Indicates a successful creation on all servers.
Definition: CreateGraph.cs:724
string graph_name
Name of the graph resource to generate.
Definition: CreateGraph.cs:196
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:102
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:700
A set of results returned by Kinetica.createGraph.
Definition: CreateGraph.cs:721
long num_edges
Total number of edges created.
Definition: CreateGraph.cs:730
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
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:114
long num_nodes
Total number of nodes created.
Definition: CreateGraph.cs:727
IList< string > restrictions
Restrictions represent a method of informing the graph solver which edges and/or nodes should be igno...
Definition: CreateGraph.cs:266
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:252
IDictionary< string, string > options
Optional parameters.
Definition: CreateGraph.cs:447
IDictionary< string, string > info
Additional information.
Definition: CreateGraph.cs:738
IList< string > nodes
Nodes represent fundamental topological units of a graph.
Definition: CreateGraph.cs:224
const string ALLOW_MULTIPLE_EDGES
Multigraph choice; allowing multiple edges with the same node pairs if set to true,...
Definition: CreateGraph.cs:186
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:170
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:86
IList< long > edges_ids
[Deprecated] Edges given as pairs of node indices.
Definition: CreateGraph.cs:735
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: CreateGraph.cs:149
const string RECREATE
If set to TRUE and the graph (using graph_name) already exists, the graph is deleted and recreated.
Definition: CreateGraph.cs:66
const string USE_RTREE
Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges.
Definition: CreateGraph.cs:164
const string MERGE_TOLERANCE
If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allo...
Definition: CreateGraph.cs:50
const string ADD_TURNS
Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that a...
Definition: CreateGraph.cs:130
CreateGraphRequest()
Constructs a CreateGraphRequest object with default parameters.
Definition: CreateGraph.cs:451
A set of parameters for Kinetica.createGraph.
Definition: CreateGraph.cs:23
A set of string constants for the parameter options.
Definition: CreateGraph.cs:42
bool directed_graph
If set to TRUE, the graph will be directed.
Definition: CreateGraph.cs:210
A set of string constants for the parameter directed_graph.
Definition: CreateGraph.cs:33
IList< string > edges
Edges represent the required fundamental topological unit of a graph that typically connect nodes.
Definition: CreateGraph.cs:238