ShowGraphRequest Class Reference
A set of parameters for Kinetica.showGraph. More...
Inheritance diagram for ShowGraphRequest:
Collaboration diagram for ShowGraphRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| ShowGraphRequest () | |
| Constructs a ShowGraphRequest object with default parameters. More... | |
| ShowGraphRequest (string graph_name=null, IDictionary< string, string > options=null) | |
| Constructs a ShowGraphRequest object with the specified parameters. More... | |
| Public Member Functions inherited from KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| string | graph_name = "" [get, set] |
| Name of the graph on which to retrieve information. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
| Properties inherited from Avro.Specific.ISpecificRecord | |
| Schema | Schema [get] |
Additional Inherited Members | |
| Static Public Member Functions inherited from KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
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/2]
|
inline |
Constructs a ShowGraphRequest object with default parameters.
Definition at line 122 of file ShowGraph.cs.
◆ ShowGraphRequest() [2/2]
|
inline |
Constructs a ShowGraphRequest object with the specified parameters.
- Parameters
-
graph_name 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 ''. options 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.
Definition at line 178 of file ShowGraph.cs.
Property Documentation
◆ 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 68 of file ShowGraph.cs.
◆ options
|
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 118 of file ShowGraph.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/ShowGraph.cs
