Kinetica   C#   API  Version 7.2.3.1
ModifyGraph.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 
22 {
26  public struct Options
27  {
33  public const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value";
34 
48  public const string EXPORT_CREATE_RESULTS = "export_create_results";
49 
50  public const string TRUE = "true";
51  public const string FALSE = "false";
52 
71  public const string ENABLE_GRAPH_DRAW = "enable_graph_draw";
72 
88  public const string SAVE_PERSIST = "save_persist";
89 
104  public const string ADD_TABLE_MONITOR = "add_table_monitor";
105 
116  public const string GRAPH_TABLE = "graph_table";
117 
132  public const string REMOVE_LABEL_ONLY = "remove_label_only";
133 
148  public const string ADD_TURNS = "add_turns";
149 
157  public const string TURN_ANGLE = "turn_angle";
158 
172  public const string USE_RTREE = "use_rtree";
173 
178  public const string LABEL_DELIMITER = "label_delimiter";
179 
194  public const string ALLOW_MULTIPLE_EDGES = "allow_multiple_edges";
195 
200  public const string EMBEDDING_TABLE = "embedding_table";
201  } // end struct Options
202 
204  public string graph_name { get; set; }
205 
223  public IList<string> nodes { get; set; } = new List<string>();
224 
242  public IList<string> edges { get; set; } = new List<string>();
243 
262  public IList<string> weights { get; set; } = new List<string>();
263 
283  public IList<string> restrictions { get; set; } = new List<string>();
284 
499  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
500 
503  public ModifyGraphRequest() { }
504 
792  IList<string> nodes,
793  IList<string> edges,
794  IList<string> weights,
795  IList<string> restrictions,
796  IDictionary<string, string> options = null)
797  {
798  this.graph_name = graph_name ?? "";
799  this.nodes = nodes ?? new List<string>();
800  this.edges = edges ?? new List<string>();
801  this.weights = weights ?? new List<string>();
802  this.restrictions = restrictions ?? new List<string>();
803  this.options = options ?? new Dictionary<string, string>();
804  } // end constructor
805 } // end class ModifyGraphRequest
806 
811 {
813  public bool result { get; set; }
814 
816  public long num_nodes { get; set; }
817 
819  public long num_edges { get; set; }
820 
826  public IList<long> edges_ids { get; set; } = new List<long>();
827 
829  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
830 } // end class ModifyGraphResponse
const string EXPORT_CREATE_RESULTS
If set to TRUE, returns the graph topology in the response as arrays.
Definition: ModifyGraph.cs:48
A set of results returned by Kinetica.modifyGraph.
Definition: ModifyGraph.cs:810
const string TURN_ANGLE
Value in degrees modifies the thresholds for attributing right, left, sharp turns,...
Definition: ModifyGraph.cs:157
long num_edges
Total number of edges in the graph.
Definition: ModifyGraph.cs:819
const string EMBEDDING_TABLE
If table exists (should be generated by the match/graph match_embedding solver), the vector embedding...
Definition: ModifyGraph.cs:200
IList< long > edges_ids
Edges given as pairs of node indices.
Definition: ModifyGraph.cs:826
ModifyGraphRequest()
Constructs a ModifyGraphRequest object with default parameters.
Definition: ModifyGraph.cs:503
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IDictionary< string, string > info
Additional information.
Definition: ModifyGraph.cs:829
A set of string constants for the parameter options.
Definition: ModifyGraph.cs:26
const string RESTRICTION_THRESHOLD_VALUE
Value-based restriction comparison.
Definition: ModifyGraph.cs:33
IList< string > restrictions
Restrictions with which to update existing restrictions in graph specified by graph_name.
Definition: ModifyGraph.cs:283
string graph_name
Name of the graph resource to modify.
Definition: ModifyGraph.cs:204
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: ModifyGraph.cs:88
const string ENABLE_GRAPH_DRAW
If set to TRUE, adds a 'EDGE_WKTLINE' column identifier to the specified GRAPH_TABLE so the graph can...
Definition: ModifyGraph.cs:71
IDictionary< string, string > options
Optional parameters.
Definition: ModifyGraph.cs:499
IList< string > weights
Weights with which to update existing weights in graph specified by graph_name.
Definition: ModifyGraph.cs:262
const string ADD_TURNS
Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that a...
Definition: ModifyGraph.cs:148
A set of parameters for Kinetica.modifyGraph.
Definition: ModifyGraph.cs:21
IList< string > edges
Edges with which to update existing edges in graph specified by graph_name.
Definition: ModifyGraph.cs:242
const string GRAPH_TABLE
If specified, the created graph is also created as a table with the given name, in [schema_name.
Definition: ModifyGraph.cs:116
long num_nodes
Total number of nodes in the graph.
Definition: ModifyGraph.cs:816
ModifyGraphRequest(string graph_name, IList< string > nodes, IList< string > edges, IList< string > weights, IList< string > restrictions, IDictionary< string, string > options=null)
Constructs a ModifyGraphRequest object with the specified parameters.
Definition: ModifyGraph.cs:791
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: ModifyGraph.cs:104
const string LABEL_DELIMITER
If provided the label string will be split according to this delimiter and each sub-string will be ap...
Definition: ModifyGraph.cs:178
IList< string > nodes
Nodes with which to update existing nodes in graph specified by graph_name.
Definition: ModifyGraph.cs:223
const string ALLOW_MULTIPLE_EDGES
Multigraph choice; allowing multiple edges with the same node pairs if set to true,...
Definition: ModifyGraph.cs:194
const string USE_RTREE
Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges.
Definition: ModifyGraph.cs:172
const string REMOVE_LABEL_ONLY
When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but o...
Definition: ModifyGraph.cs:132
bool result
Indicates a successful modification on all servers.
Definition: ModifyGraph.cs:813