Skip to main content

A set of results returned by Kinetica.showGraph. More…

Inheritance diagram for kinetica.ShowGraphResponse:
Collaboration diagram for kinetica.ShowGraphResponse:

Properties

bool result [get, set]
 Indicates a success.
 
IList< int > load = new List<int>() [get, set]
 A percentage approximating the current computational load on the server.
 
IList< long > memory = new List<long>() [get, set]
 Available memory.
 
IList< string > graph_names = new List<string>() [get, set]
 Name(s) of the graph(s).
 
IList< int > graph_server_ids = new List<int>() [get, set]
 Id(s) of the graph(s).
 
IList< string > graph_owner_user_names = new List<string>() [get, set]
 Owner of the graph(s) and associated solution table(s).
 
IList< string > graph_owner_resource_groups = new List<string>() [get, set]
 Owner of the resource groups(s) of the graph(s).
 
IList< bool > directed = new List<bool>() [get, set]
 Whether or not the edges of the graph have directions (bi-directional edges can still exist in directed graphs).
 
IList< long > num_nodes = new List<long>() [get, set]
 Total number of nodes in the graph.
 
IList< long > num_edges = new List<long>() [get, set]
 Total number of edges in the graph.
 
IList< long > num_bytes = new List<long>() [get, set]
 Memory this graph uses in bytes.
 
IList< long > resource_capacity = new List<long>() [get, set]
 Memory this graph uses in bytes.
 
IList< bool > is_persisted = new List<bool>() [get, set]
 Shows whether or not the graph is persisted (saved and loaded on launch).
 
IList< bool > is_partitioned = new List<bool>() [get, set]
 Indicates if the graph data is distributed across all available servers.
 
IList< bool > is_sync_db = new List<bool>() [get, set]
 Shows whether or not the graph is linked to the original tables that created it, and will potentially be re-created instead loaded from persist on launch.
 
IList< bool > has_insert_table_monitor = new List<bool>() [get, set]
 Shows whether or not the graph has an insert table monitor attached to it.
 
IList< string > original_request = new List<string>() [get, set]
 The original client request used to create the graph (before any expression evaluation or separator processing).
 
IDictionary< string, string > info = new Dictionary<string, string>() [get, set]
 Additional information.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

Additional Inherited Members

 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of results returned by Kinetica.showGraph.

Definition at line 219 of file ShowGraph.cs.

Property Documentation

◆ directed

IList< bool > kinetica.ShowGraphResponse.directed = new List<bool>()
getset

Whether or not the edges of the graph have directions (bi-directional edges can still exist in directed graphs).

Consult Directed Graphs for more details.

Definition at line 251 of file ShowGraph.cs.

◆ graph_names

IList< string > kinetica.ShowGraphResponse.graph_names = new List<string>()
getset

Name(s) of the graph(s).

Definition at line 234 of file ShowGraph.cs.

◆ graph_owner_resource_groups

IList< string > kinetica.ShowGraphResponse.graph_owner_resource_groups = new List<string>()
getset

Owner of the resource groups(s) of the graph(s).

Definition at line 244 of file ShowGraph.cs.

◆ graph_owner_user_names

IList< string > kinetica.ShowGraphResponse.graph_owner_user_names = new List<string>()
getset

Owner of the graph(s) and associated solution table(s).

Definition at line 241 of file ShowGraph.cs.

◆ graph_server_ids

IList< int > kinetica.ShowGraphResponse.graph_server_ids = new List<int>()
getset

Id(s) of the graph(s).

Definition at line 237 of file ShowGraph.cs.

◆ has_insert_table_monitor

IList< bool > kinetica.ShowGraphResponse.has_insert_table_monitor = new List<bool>()
getset

Shows whether or not the graph has an insert table monitor attached to it.

Definition at line 280 of file ShowGraph.cs.

◆ info

IDictionary< string, string > kinetica.ShowGraphResponse.info = new Dictionary<string, string>()
getset

Additional information.

Definition at line 287 of file ShowGraph.cs.

◆ is_partitioned

IList< bool > kinetica.ShowGraphResponse.is_partitioned = new List<bool>()
getset

Indicates if the graph data is distributed across all available servers.

Definition at line 271 of file ShowGraph.cs.

◆ is_persisted

IList< bool > kinetica.ShowGraphResponse.is_persisted = new List<bool>()
getset

Shows whether or not the graph is persisted (saved and loaded on launch).

Definition at line 267 of file ShowGraph.cs.

◆ is_sync_db

IList< bool > kinetica.ShowGraphResponse.is_sync_db = new List<bool>()
getset

Shows whether or not the graph is linked to the original tables that created it, and will potentially be re-created instead loaded from persist on launch.

Definition at line 276 of file ShowGraph.cs.

◆ load

IList< int > kinetica.ShowGraphResponse.load = new List<int>()
getset

A percentage approximating the current computational load on the server.

Definition at line 228 of file ShowGraph.cs.

◆ memory

IList< long > kinetica.ShowGraphResponse.memory = new List<long>()
getset

Available memory.

Definition at line 231 of file ShowGraph.cs.

◆ num_bytes

IList< long > kinetica.ShowGraphResponse.num_bytes = new List<long>()
getset

Memory this graph uses in bytes.

Definition at line 260 of file ShowGraph.cs.

◆ num_edges

IList< long > kinetica.ShowGraphResponse.num_edges = new List<long>()
getset

Total number of edges in the graph.

Definition at line 257 of file ShowGraph.cs.

◆ num_nodes

IList< long > kinetica.ShowGraphResponse.num_nodes = new List<long>()
getset

Total number of nodes in the graph.

Definition at line 254 of file ShowGraph.cs.

◆ original_request

IList< string > kinetica.ShowGraphResponse.original_request = new List<string>()
getset

The original client request used to create the graph (before any expression evaluation or separator processing).

Definition at line 284 of file ShowGraph.cs.

◆ resource_capacity

IList< long > kinetica.ShowGraphResponse.resource_capacity = new List<long>()
getset

Memory this graph uses in bytes.

Definition at line 263 of file ShowGraph.cs.

◆ result

bool kinetica.ShowGraphResponse.result
getset

Indicates a success.

This call will fail if the graph specified in the request does not exist.

Definition at line 224 of file ShowGraph.cs.


The documentation for this class was generated from the following files:
  • _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowGraph.cs
  • Kinetica/Protocol/ShowGraph.cs