Skip to main content

A set of parameters for Kinetica.showGraph. More…

Inheritance diagram for kinetica.ShowGraphRequest:
[legend]
Collaboration diagram for kinetica.ShowGraphRequest:
[legend]

​
Classes

struct  Options
 A set of string constants for the parameter ShowGraphRequest.options. More…
 

​
Public Member Functions

 ShowGraphRequest ()
 Constructs a ShowGraphRequest object with default parameters.
 
 ShowGraphRequest (string graph_name=null, IDictionary< string, string > options=null)
 Constructs a ShowGraphRequest object with the specified parameters.
 
 ShowGraphRequest ()
 Constructs a ShowGraphRequest object with default parameters.
 
 ShowGraphRequest (string graph_name=null, IDictionary< string, string > options=null)
 Constructs a ShowGraphRequest object with the specified parameters.
 
 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.
 

​
Properties

string graph_name = "" [get, set]
 Name of the graph on which to retrieve information.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
Additional Inherited Members

 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 parameters for Kinetica.showGraph.

Shows information and characteristics of graphs that exist on the graph server.

Definition at line 16 of file ShowGraph.cs.

​
Constructor & Destructor Documentation

​
◆ ShowGraphRequest() [1/4]

kinetica.ShowGraphRequest.ShowGraphRequest ()
 inline

Constructs a ShowGraphRequest object with default parameters.

Definition at line 142 of file ShowGraph.cs.

​
◆ ShowGraphRequest() [2/4]

kinetica.ShowGraphRequest.ShowGraphRequest (stringgraph_name = null,
IDictionary< string, string >options = null )
 inline

Constructs a ShowGraphRequest object with the specified parameters.

Parameters
graph_nameName of the graph on which to retrieve information. If left as the default value, information about all graphs is returned. The default value is ”.
optionsOptional parameters.
  • SHOW_ORIGINAL_REQUEST: If set to TRUE, the request that was originally used to create the graph is also returned as JSON. Supported values:The default value is TRUE.
  • SERVER_ID: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
  • EXPORT_GRAPH_SCHEMA: If true, generates the graph ontology (schema) as a DOT format string in the response info field under the key ‘dot’. Supported values:The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 208 of file ShowGraph.cs.

​
◆ ShowGraphRequest() [3/4]

kinetica.ShowGraphRequest.ShowGraphRequest ()
 inline

Constructs a ShowGraphRequest object with default parameters.

Definition at line 142 of file ShowGraph.cs.

​
◆ ShowGraphRequest() [4/4]

kinetica.ShowGraphRequest.ShowGraphRequest (stringgraph_name = null,
IDictionary< string, string >options = null )
 inline

Constructs a ShowGraphRequest object with the specified parameters.

Parameters
graph_nameName of the graph on which to retrieve information. If left as the default value, information about all graphs is returned. The default value is ”.
optionsOptional parameters.
  • SHOW_ORIGINAL_REQUEST: If set to TRUE, the request that was originally used to create the graph is also returned as JSON. Supported values:The default value is TRUE.
  • SERVER_ID: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
  • EXPORT_GRAPH_SCHEMA: If true, generates the graph ontology (schema) as a DOT format string in the response info field under the key ‘dot’. Supported values:The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 208 of file ShowGraph.cs.

​
Property Documentation

​
◆ graph_name

string kinetica.ShowGraphRequest.graph_name = ""
 getset

Name of the graph on which to retrieve information.

If left as the default value, information about all graphs is returned. The default value is ”.

Definition at line 78 of file ShowGraph.cs.

​
◆ options

IDictionary< string, string > kinetica.ShowGraphRequest.options = new Dictionary<string, string>()
 getset

Optional parameters.

  • SHOW_ORIGINAL_REQUEST: If set to TRUE, the request that was originally used to create the graph is also returned as JSON. Supported values:The default value is TRUE.
  • SERVER_ID: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
  • EXPORT_GRAPH_SCHEMA: If true, generates the graph ontology (schema) as a DOT format string in the response info field under the key ‘dot’. Supported values:The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 138 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