Kinetica   C#   API  Version 7.2.3.0
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 
105  public const string ADD_TABLE_MONITOR = "add_table_monitor";
106 
118  public const string GRAPH_TABLE = "graph_table";
119 
134  public const string REMOVE_LABEL_ONLY = "remove_label_only";
135 
150  public const string ADD_TURNS = "add_turns";
151 
161  public const string TURN_ANGLE = "turn_angle";
162 
176  public const string USE_RTREE = "use_rtree";
177 
182  public const string LABEL_DELIMITER = "label_delimiter";
183 
198  public const string ALLOW_MULTIPLE_EDGES = "allow_multiple_edges";
199 
205  public const string EMBEDDING_TABLE = "embedding_table";
206  } // end struct Options
207 
209  public string graph_name { get; set; }
210 
230  public IList<string> nodes { get; set; } = new List<string>();
231 
251  public IList<string> edges { get; set; } = new List<string>();
252 
271  public IList<string> weights { get; set; } = new List<string>();
272 
293  public IList<string> restrictions { get; set; } = new List<string>();
294 
514  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
515 
518  public ModifyGraphRequest() { }
519 
820  IList<string> nodes,
821  IList<string> edges,
822  IList<string> weights,
823  IList<string> restrictions,
824  IDictionary<string, string> options = null)
825  {
826  this.graph_name = graph_name ?? "";
827  this.nodes = nodes ?? new List<string>();
828  this.edges = edges ?? new List<string>();
829  this.weights = weights ?? new List<string>();
830  this.restrictions = restrictions ?? new List<string>();
831  this.options = options ?? new Dictionary<string, string>();
832  } // end constructor
833  } // end class ModifyGraphRequest
834 
839  {
842  public bool result { get; set; }
843 
845  public long num_nodes { get; set; }
846 
848  public long num_edges { get; set; }
849 
855  public IList<long> edges_ids { get; set; } = new List<long>();
856 
858  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
859  } // end class ModifyGraphResponse
860 } // end namespace kinetica
A set of parameters for Kinetica.modifyGraph.
Definition: ModifyGraph.cs:21
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:819
A set of string constants for the parameter options.
Definition: ModifyGraph.cs:26
IDictionary< string, string > options
Optional parameters.
Definition: ModifyGraph.cs:514
IList< long > edges_ids
Edges given as pairs of node indices.
Definition: ModifyGraph.cs:855
ModifyGraphRequest()
Constructs a ModifyGraphRequest object with default parameters.
Definition: ModifyGraph.cs:518
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:118
IList< string > weights
Weights with which to update existing weights in graph specified by graph_name.
Definition: ModifyGraph.cs:271
const string EXPORT_CREATE_RESULTS
If set to TRUE, returns the graph topology in the response as arrays.
Definition: ModifyGraph.cs:48
const string RESTRICTION_THRESHOLD_VALUE
Value-based restriction comparison.
Definition: ModifyGraph.cs:33
IList< string > nodes
Nodes with which to update existing nodes in graph specified by graph_name.
Definition: ModifyGraph.cs:230
IList< string > restrictions
Restrictions with which to update existing restrictions in graph specified by graph_name.
Definition: ModifyGraph.cs:293
string graph_name
Name of the graph resource to modify.
Definition: ModifyGraph.cs:209
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:182
IDictionary< string, string > info
Additional information.
Definition: ModifyGraph.cs:858
const string ALLOW_MULTIPLE_EDGES
Multigraph choice; allowing multiple edges with the same node pairs if set to true,...
Definition: ModifyGraph.cs:198
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:105
const string USE_RTREE
Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges.
Definition: ModifyGraph.cs:176
const string ADD_TURNS
Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that a...
Definition: ModifyGraph.cs:150
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
IList< string > edges
Edges with which to update existing edges in graph specified by graph_name.
Definition: ModifyGraph.cs:251
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
long num_nodes
Total number of nodes in the graph.
Definition: ModifyGraph.cs:845
const string TURN_ANGLE
Value in degrees modifies the thresholds for attributing right, left, sharp turns,...
Definition: ModifyGraph.cs:161
A set of results returned by Kinetica.modifyGraph.
Definition: ModifyGraph.cs:838
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
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:134
long num_edges
Total number of edges in the graph.
Definition: ModifyGraph.cs:848
const string EMBEDDING_TABLE
If table exists (should be generated by the match/graph match_embedding solver), the vector embedding...
Definition: ModifyGraph.cs:205
bool result
Indicates a successful modification on all servers.
Definition: ModifyGraph.cs:842