com.gpudb.protocol

Class DeleteGraphRequest

java.lang.Object

com.gpudb.protocol.DeleteGraphRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

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

A set of parameters for GPUdb.deleteGraph.

Deletes an existing graph from the graph server and/or persist.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
DeleteGraphRequest() Constructs a DeleteGraphRequest object with default parameters.
DeleteGraphRequest(String graphName, Map<String,String> options) Constructs a DeleteGraphRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and 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 to be deleted.
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.
DeleteGraphRequest	setGraphName(String graphName) Name of the graph to be deleted.
DeleteGraphRequest	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

DeleteGraphRequest

public DeleteGraphRequest()

Constructs a DeleteGraphRequest object with default parameters.

DeleteGraphRequest

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

Constructs a DeleteGraphRequest object with the specified parameters.

Parameters:

graphName - Name of the graph to be deleted.

options - Optional parameters.

• DELETE_PERSIST: If set to TRUE, the graph is removed from the server and persist. If set to FALSE, the graph is removed from the server but is left in persist. The graph can be reloaded from persist if it is recreated with the same 'graph_name'. 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 to be deleted.

Returns:

The current value of graphName.

setGraphName

public DeleteGraphRequest setGraphName(String graphName)

Name of the graph to be deleted.

Parameters:

graphName - The new value for graphName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• DELETE_PERSIST: If set to TRUE, the graph is removed from the server and persist. If set to FALSE, the graph is removed from the server but is left in persist. The graph can be reloaded from persist if it is recreated with the same 'graph_name'. 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 DeleteGraphRequest setOptions(Map<String,String> options)

Optional parameters.

• DELETE_PERSIST: If set to TRUE, the graph is removed from the server and persist. If set to FALSE, the graph is removed from the server but is left in persist. The graph can be reloaded from persist if it is recreated with the same 'graph_name'. 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