Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
10 
11 namespace kinetica
12 {
13 
20  {
21 
54  public struct Options
55  {
56 
72  public const string SHOW_ORIGINAL_REQUEST = "show_original_request";
73  public const string TRUE = "true";
74  public const string FALSE = "false";
75 
79  public const string SERVER_ID = "server_id";
80  } // end struct Options
81 
82 
86  public string graph_name { get; set; } = "";
87 
118  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
119 
120 
123  public ShowGraphRequest() { }
124 
162  public ShowGraphRequest( string graph_name = null,
163  IDictionary<string, string> options = null)
164  {
165  this.graph_name = graph_name ?? "";
166  this.options = options ?? new Dictionary<string, string>();
167  } // end constructor
168 
169  } // end class ShowGraphRequest
170 
171 
172 
177  {
178 
181  public bool result { get; set; }
182 
185  public IList<int> load { get; set; } = new List<int>();
186 
188  public IList<long> memory { get; set; } = new List<long>();
189 
191  public IList<string> graph_names { get; set; } = new List<string>();
192 
194  public IList<int> graph_server_ids { get; set; } = new List<int>();
195 
198  public IList<string> graph_owner_user_names { get; set; } = new List<string>();
199 
202  public IList<string> graph_owner_resource_groups { get; set; } = new List<string>();
203 
209  public IList<bool> directed { get; set; } = new List<bool>();
210 
212  public IList<long> num_nodes { get; set; } = new List<long>();
213 
215  public IList<long> num_edges { get; set; } = new List<long>();
216 
218  public IList<long> num_bytes { get; set; } = new List<long>();
219 
221  public IList<long> resource_capacity { get; set; } = new List<long>();
222 
225  public IList<bool> is_persisted { get; set; } = new List<bool>();
226 
229  public IList<bool> is_partitioned { get; set; } = new List<bool>();
230 
234  public IList<bool> is_sync_db { get; set; } = new List<bool>();
235 
238  public IList<bool> has_insert_table_monitor { get; set; } = new List<bool>();
239 
243  public IList<string> original_request { get; set; } = new List<string>();
244 
246  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
247 
248  } // end class ShowGraphResponse
249 
250 
251 
252 
253 } // end namespace kinetica
IList< long > num_bytes
Memory this graph uses in bytes.
Definition: ShowGraph.cs:218
IDictionary< string, string > options
Optional parameters.
Definition: ShowGraph.cs:118
IList< bool > is_partitioned
Indicated if the graph data is distributed across all available servers.
Definition: ShowGraph.cs:229
IList< int > load
A percentage approximating the current computational load on the server.
Definition: ShowGraph.cs:185
IList< int > graph_server_ids
Id(s) of the graph(s).
Definition: ShowGraph.cs:194
bool result
Indicates a success.
Definition: ShowGraph.cs:181
ShowGraphRequest()
Constructs a ShowGraphRequest object with default parameters.
Definition: ShowGraph.cs:123
IList< long > num_edges
Total number of edges in the graph.
Definition: ShowGraph.cs:215
A set of parameters for Kinetica.showGraph(string,IDictionary{string, string}).
Definition: ShowGraph.cs:19
IList< string > graph_names
Name(s) of the graph(s).
Definition: ShowGraph.cs:191
IList< long > num_nodes
Total number of nodes in the graph.
Definition: ShowGraph.cs:212
string graph_name
Name of the graph on which to retrieve information.
Definition: ShowGraph.cs:86
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: ShowGraph.cs:79
A set of results returned by Kinetica.showGraph(string,IDictionary{string, string}).
Definition: ShowGraph.cs:176
IList< long > memory
Available memory.
Definition: ShowGraph.cs:188
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:234
IList< bool > has_insert_table_monitor
Shows whether or not the graph has an insert table monitor attached to it.
Definition: ShowGraph.cs:238
IList< long > resource_capacity
Memory this graph uses in bytes.
Definition: ShowGraph.cs:221
ShowGraphRequest(string graph_name=null, IDictionary< string, string > options=null)
Constructs a ShowGraphRequest object with the specified parameters.
Definition: ShowGraph.cs:162
IList< string > graph_owner_user_names
Owner of the graph(s) and associated solution table(s).
Definition: ShowGraph.cs:198
IList< bool > directed
Whether or not the edges of the graph have directions (bi-directional edges can still exist in direct...
Definition: ShowGraph.cs:209
IList< string > original_request
The original client request used to create the graph (before any expression evaluation or separator p...
Definition: ShowGraph.cs:243
IList< string > graph_owner_resource_groups
Owner of the resource groups(s) of the graph(s).
Definition: ShowGraph.cs:202
Optional parameters.
Definition: ShowGraph.cs:54
IDictionary< string, string > info
Additional information.
Definition: ShowGraph.cs:246
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IList< bool > is_persisted
Shows whether or not the graph is persisted (saved and loaded on launch).
Definition: ShowGraph.cs:225
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:72