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

public class ShowGraphRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.showGraph.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShowGraphRequest.Options	A set of string constants for the ShowGraphRequest parameter options.

Constructor Summary

Constructors

Constructor	Description
ShowGraphRequest()	Constructs 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 Type	Method	Description
boolean	equals(Object obj)
Object	get(int index)	This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
String	getGraphName()	Name of the graph on which to retrieve information.
Map<String,String>	getOptions()	Optional parameters.
org.apache.avro.Schema	getSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value)	This method supports the Avro framework and is not intended to be called directly by the user.
ShowGraphRequest	setGraphName(String graphName)	Name of the graph on which to retrieve information.
ShowGraphRequest	setOptions(Map<String,String> options)	Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShowGraphRequest

public ShowGraphRequest()

Constructs a ShowGraphRequest object with default parameters.

ShowGraphRequest

public ShowGraphRequest(String graphName,
                        Map<String,String> options)

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

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

The schema for the class.

getGraphName

public String getGraphName()

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

Returns:

The current value of graphName.

setGraphName

public ShowGraphRequest setGraphName(String 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 ''.

Parameters:

graphName - The new value for graphName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

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

Returns:

The current value of options.

setOptions

public ShowGraphRequest setOptions(Map<String,String> 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 Map.

Parameters:

options - The new value for options.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

The schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object