A set of parameters for GPUdb::showGraph. More...

Public Member Functions
	ShowGraphRequest ()
	Constructs a ShowGraphRequest object with default parameters. More...

	ShowGraphRequest (const std::string &graphName_, const std::map< std::string, std::string > &options_)
	Constructs a ShowGraphRequest object with the specified parameters. More...

Public Attributes
std::string	graphName
	Name of the graph on which to retrieve information. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::showGraph.

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

Definition at line 18 of file show_graph.h.

Constructor & Destructor Documentation

gpudb::ShowGraphRequest::ShowGraphRequest ( )

inline

Constructs a ShowGraphRequest object with default parameters.

Definition at line 23 of file show_graph.h.

gpudb::ShowGraphRequest::ShowGraphRequest	(	const std::string &	graphName_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a ShowGraphRequest object with the specified parameters.

Parameters

[in]	graphName_	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 ''.
[in]	options_	Optional parameters. show_graph_show_original_request: If set to true, the request that was originally used to create the graph is also returned as JSON. Supported values: show_graph_true show_graph_false The default value is show_graph_true. show_graph_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 map.

Definition at line 63 of file show_graph.h.

std::string gpudb::ShowGraphRequest::graphName

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 74 of file show_graph.h.

std::map<std::string, std::string> gpudb::ShowGraphRequest::options

Optional parameters.

show_graph_show_original_request: If set to true, the request that was originally used to create the graph is also returned as JSON. Supported values:
- show_graph_true
- show_graph_false
The default value is show_graph_true.
show_graph_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 map.

Definition at line 97 of file show_graph.h.

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