Kinetica   C#   API  Version 7.2.3.1
ShowGraph.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 
17 {
21  public struct Options
22  {
37  public const string SHOW_ORIGINAL_REQUEST = "show_original_request";
38 
39  public const string TRUE = "true";
40  public const string FALSE = "false";
41 
46  public const string SERVER_ID = "server_id";
47 
62  public const string EXPORT_GRAPH_SCHEMA = "export_graph_schema";
63  } // end struct Options
64 
68  public string graph_name { get; set; } = "";
69 
118  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
119 
122  public ShowGraphRequest() { }
123 
178  public ShowGraphRequest( string graph_name = null,
179  IDictionary<string, string> options = null)
180  {
181  this.graph_name = graph_name ?? "";
182  this.options = options ?? new Dictionary<string, string>();
183  } // end constructor
184 } // end class ShowGraphRequest
185 
190 {
194  public bool result { get; set; }
195 
198  public IList<int> load { get; set; } = new List<int>();
199 
201  public IList<long> memory { get; set; } = new List<long>();
202 
204  public IList<string> graph_names { get; set; } = new List<string>();
205 
207  public IList<int> graph_server_ids { get; set; } = new List<int>();
208 
211  public IList<string> graph_owner_user_names { get; set; } = new List<string>();
212 
214  public IList<string> graph_owner_resource_groups { get; set; } = new List<string>();
215 
221  public IList<bool> directed { get; set; } = new List<bool>();
222 
224  public IList<long> num_nodes { get; set; } = new List<long>();
225 
227  public IList<long> num_edges { get; set; } = new List<long>();
228 
230  public IList<long> num_bytes { get; set; } = new List<long>();
231 
233  public IList<long> resource_capacity { get; set; } = new List<long>();
234 
237  public IList<bool> is_persisted { get; set; } = new List<bool>();
238 
241  public IList<bool> is_partitioned { get; set; } = new List<bool>();
242 
246  public IList<bool> is_sync_db { get; set; } = new List<bool>();
247 
250  public IList<bool> has_insert_table_monitor { get; set; } = new List<bool>();
251 
254  public IList<string> original_request { get; set; } = new List<string>();
255 
257  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
258 } // end class ShowGraphResponse
IList< bool > is_sync_db
Shows whether or not the graph is linked to the original tables that created it, and will potentially...
Definition: ShowGraph.cs:246
const string EXPORT_GRAPH_SCHEMA
If true, generates the graph ontology (schema) as a DOT format string in the response info field unde...
Definition: ShowGraph.cs:62
IList< string > graph_owner_user_names
Owner of the graph(s) and associated solution table(s).
Definition: ShowGraph.cs:211
A set of parameters for Kinetica.showGraph.
Definition: ShowGraph.cs:16
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IList< bool > directed
Whether or not the edges of the graph have directions (bi-directional edges can still exist in direct...
Definition: ShowGraph.cs:221
A set of string constants for the parameter options.
Definition: ShowGraph.cs:21
const string FALSE
Definition: ShowGraph.cs:40
IList< int > load
A percentage approximating the current computational load on the server.
Definition: ShowGraph.cs:198
IList< string > graph_owner_resource_groups
Owner of the resource groups(s) of the graph(s).
Definition: ShowGraph.cs:214
IDictionary< string, string > options
Optional parameters.
Definition: ShowGraph.cs:118
IList< int > graph_server_ids
Id(s) of the graph(s).
Definition: ShowGraph.cs:207
A set of results returned by Kinetica.showGraph.
Definition: ShowGraph.cs:189
IList< bool > is_partitioned
Indicates if the graph data is distributed across all available servers.
Definition: ShowGraph.cs:241
IList< long > memory
Available memory.
Definition: ShowGraph.cs:201
IList< string > graph_names
Name(s) of the graph(s).
Definition: ShowGraph.cs:204
IList< bool > has_insert_table_monitor
Shows whether or not the graph has an insert table monitor attached to it.
Definition: ShowGraph.cs:250
IList< bool > is_persisted
Shows whether or not the graph is persisted (saved and loaded on launch).
Definition: ShowGraph.cs:237
const string SHOW_ORIGINAL_REQUEST
If set to TRUE, the request that was originally used to create the graph is also returned as JSON.
Definition: ShowGraph.cs:37
IList< long > num_edges
Total number of edges in the graph.
Definition: ShowGraph.cs:227
IList< long > num_nodes
Total number of nodes in the graph.
Definition: ShowGraph.cs:224
ShowGraphRequest()
Constructs a ShowGraphRequest object with default parameters.
Definition: ShowGraph.cs:122
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: ShowGraph.cs:46
IList< long > num_bytes
Memory this graph uses in bytes.
Definition: ShowGraph.cs:230
IDictionary< string, string > info
Additional information.
Definition: ShowGraph.cs:257
bool result
Indicates a success.
Definition: ShowGraph.cs:194
string graph_name
Name of the graph on which to retrieve information.
Definition: ShowGraph.cs:68
IList< long > resource_capacity
Memory this graph uses in bytes.
Definition: ShowGraph.cs:233
ShowGraphRequest(string graph_name=null, IDictionary< string, string > options=null)
Constructs a ShowGraphRequest object with the specified parameters.
Definition: ShowGraph.cs:178
IList< string > original_request
The original client request used to create the graph (before any expression evaluation or separator p...
Definition: ShowGraph.cs:254