Package com.gpudb.protocol
Class ShowGraphRequest
java.lang.Object
com.gpudb.protocol.ShowGraphRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecordA set of parameters for
GPUdb.showGraph.
Shows information and characteristics of graphs that exist on the graph server.
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theShowGraphRequestparameteroptions.Constructor Summary
ConstructorsConstructorDescriptionConstructs a ShowGraphRequest object with default parameters.ShowGraphRequest(String graphName, Map<String, String> options) Constructs a ShowGraphRequest object with the specified parameters.Method Summary
Modifier and TypeMethodDescriptionbooleanget(int index) This method supports the Avro framework and is not intended to be called directly by the user.static org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.Name of the graph on which to retrieve information.Optional parameters.org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.inthashCode()voidThis method supports the Avro framework and is not intended to be called directly by the user.setGraphName(String graphName) Name of the graph on which to retrieve information.setOptions(Map<String, String> options) Optional parameters.toString()
Constructor Details
ShowGraphRequest
Constructs a ShowGraphRequest object with the specified parameters.Parameters: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 ”.options- Optional parameters.SHOW_ORIGINAL_REQUEST: If set toTRUE, the request that was originally used to create the graph is also returned as JSON. Supported values:The default value isTRUE.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 isFALSE.
Map.
Method Details
getOptions
Optional parameters.SHOW_ORIGINAL_REQUEST: If set toTRUE, the request that was originally used to create the graph is also returned as JSON. Supported values:The default value isTRUE.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 isFALSE.
Map.Returns:The current value ofoptions.setOptions
Optional parameters.SHOW_ORIGINAL_REQUEST: If set toTRUE, the request that was originally used to create the graph is also returned as JSON. Supported values:The default value isTRUE.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 isFALSE.
Map.Parameters:options- The new value foroptions.Returns:thisto mimic the builder pattern.