A set of parameters for Kinetica.showGraph. More...

Inheritance diagram for kinetica.ShowGraphRequest:

Collaboration diagram for kinetica.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 kinetica.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 kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

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. 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]

kinetica.ShowGraphRequest.ShowGraphRequest ( )

inline

Constructs a ShowGraphRequest object with default parameters.

Definition at line 88 of file ShowGraph.cs.

◆ ShowGraphRequest() [2/2]

kinetica.ShowGraphRequest.ShowGraphRequest	(	string	graph_name = `null`,
		IDictionary< string, string >	options = `null`
	)

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: TRUE FALSE 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. The default value is an empty Dictionary.

Definition at line 125 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 53 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:
- TRUE
- FALSE
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.

The default value is an empty Dictionary.

Definition at line 84 of file ShowGraph.cs.

The documentation for this class was generated from the following file:

Kinetica/Protocol/ShowGraph.cs

Classes

Public Member Functions

Properties