Kinetica   C#   API  Version 7.2.3.0
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  } // end struct Options
48 
53  public string graph_name { get; set; } = "";
54 
84  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
85 
88  public ShowGraphRequest() { }
89 
125  public ShowGraphRequest( string graph_name = null,
126  IDictionary<string, string> options = null)
127  {
128  this.graph_name = graph_name ?? "";
129  this.options = options ?? new Dictionary<string, string>();
130  } // end constructor
131  } // end class ShowGraphRequest
132 
137  {
141  public bool result { get; set; }
142 
145  public IList<int> load { get; set; } = new List<int>();
146 
148  public IList<long> memory { get; set; } = new List<long>();
149 
151  public IList<string> graph_names { get; set; } = new List<string>();
152 
154  public IList<int> graph_server_ids { get; set; } = new List<int>();
155 
158  public IList<string> graph_owner_user_names { get; set; } = new List<string>();
159 
161  public IList<string> graph_owner_resource_groups { get; set; } = new List<string>();
162 
170  public IList<bool> directed { get; set; } = new List<bool>();
171 
173  public IList<long> num_nodes { get; set; } = new List<long>();
174 
176  public IList<long> num_edges { get; set; } = new List<long>();
177 
179  public IList<long> num_bytes { get; set; } = new List<long>();
180 
182  public IList<long> resource_capacity { get; set; } = new List<long>();
183 
186  public IList<bool> is_persisted { get; set; } = new List<bool>();
187 
190  public IList<bool> is_partitioned { get; set; } = new List<bool>();
191 
195  public IList<bool> is_sync_db { get; set; } = new List<bool>();
196 
199  public IList<bool> has_insert_table_monitor { get; set; } = new List<bool>();
200 
204  public IList<string> original_request { get; set; } = new List<string>();
205 
207  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
208  } // end class ShowGraphResponse
209 } // end namespace kinetica
IList< long > num_bytes
Memory this graph uses in bytes.
Definition: ShowGraph.cs:179
IDictionary< string, string > options
Optional parameters.
Definition: ShowGraph.cs:84
IList< bool > is_partitioned
Indicates if the graph data is distributed across all available servers.
Definition: ShowGraph.cs:190
IList< int > load
A percentage approximating the current computational load on the server.
Definition: ShowGraph.cs:145
IList< int > graph_server_ids
Id(s) of the graph(s).
Definition: ShowGraph.cs:154
bool result
Indicates a success.
Definition: ShowGraph.cs:141
ShowGraphRequest()
Constructs a ShowGraphRequest object with default parameters.
Definition: ShowGraph.cs:88
IList< long > num_edges
Total number of edges in the graph.
Definition: ShowGraph.cs:176
A set of parameters for Kinetica.showGraph.
Definition: ShowGraph.cs:16
IList< string > graph_names
Name(s) of the graph(s).
Definition: ShowGraph.cs:151
IList< long > num_nodes
Total number of nodes in the graph.
Definition: ShowGraph.cs:173
string graph_name
Name of the graph on which to retrieve information.
Definition: ShowGraph.cs:53
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: ShowGraph.cs:46
A set of results returned by Kinetica.showGraph.
Definition: ShowGraph.cs:136
IList< long > memory
Available memory.
Definition: ShowGraph.cs:148
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:195
IList< bool > has_insert_table_monitor
Shows whether or not the graph has an insert table monitor attached to it.
Definition: ShowGraph.cs:199
IList< long > resource_capacity
Memory this graph uses in bytes.
Definition: ShowGraph.cs:182
ShowGraphRequest(string graph_name=null, IDictionary< string, string > options=null)
Constructs a ShowGraphRequest object with the specified parameters.
Definition: ShowGraph.cs:125
IList< string > graph_owner_user_names
Owner of the graph(s) and associated solution table(s).
Definition: ShowGraph.cs:158
IList< bool > directed
Whether or not the edges of the graph have directions (bi-directional edges can still exist in direct...
Definition: ShowGraph.cs:170
IList< string > original_request
The original client request used to create the graph (before any expression evaluation or separator p...
Definition: ShowGraph.cs:204
IList< string > graph_owner_resource_groups
Owner of the resource groups(s) of the graph(s).
Definition: ShowGraph.cs:161
A set of string constants for the parameter options.
Definition: ShowGraph.cs:21
IDictionary< string, string > info
Additional information.
Definition: ShowGraph.cs:207
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:186
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