com.gpudb.protocol

Class RepartitionGraphRequest

java.lang.Object

com.gpudb.protocol.RepartitionGraphRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.repartitionGraph.

Rebalances an existing partitioned graph.

IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RepartitionGraphRequest() Constructs a RepartitionGraphRequest object with default parameters.
RepartitionGraphRequest(String graphName, Map<String,String> options) Constructs a RepartitionGraphRequest 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 resource to rebalance.
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.
RepartitionGraphRequest	setGraphName(String graphName) Name of the graph resource to rebalance.
RepartitionGraphRequest	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

RepartitionGraphRequest

public RepartitionGraphRequest()

Constructs a RepartitionGraphRequest object with default parameters.

RepartitionGraphRequest

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

Constructs a RepartitionGraphRequest object with the specified parameters.

Parameters:

graphName - Name of the graph resource to rebalance.

options - Optional parameters.

• NEW_GRAPH_NAME: If a non-empty value is specified, the original graph will be kept (non-default behaviour) and a new balanced graph will be created under this given name. When the value is empty (default), the generated 'balanced' graph will replace the original 'unbalanced' graph under the same graph name. The default value is ''.
• SOURCE_NODE: The distributed shortest path solve is run from this source node to all the nodes in the graph to create balaced partitions using the iso-distance levels of the solution. The source node is selected by the rebalance algorithm automatically (default case when the value is an empty string). Otherwise, the user specified node is used as the source. The default value is ''.
• SQL_REQUEST_AVRO_JSON: The default value is ''.

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 resource to rebalance.

Returns:

The current value of graphName.

setGraphName

public RepartitionGraphRequest setGraphName(String graphName)

Name of the graph resource to rebalance.

Parameters:

graphName - The new value for graphName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• NEW_GRAPH_NAME: If a non-empty value is specified, the original graph will be kept (non-default behaviour) and a new balanced graph will be created under this given name. When the value is empty (default), the generated 'balanced' graph will replace the original 'unbalanced' graph under the same graph name. The default value is ''.
• SOURCE_NODE: The distributed shortest path solve is run from this source node to all the nodes in the graph to create balaced partitions using the iso-distance levels of the solution. The source node is selected by the rebalance algorithm automatically (default case when the value is an empty string). Otherwise, the user specified node is used as the source. The default value is ''.
• SQL_REQUEST_AVRO_JSON: The default value is ''.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

public RepartitionGraphRequest setOptions(Map<String,String> options)

Optional parameters.

• NEW_GRAPH_NAME: If a non-empty value is specified, the original graph will be kept (non-default behaviour) and a new balanced graph will be created under this given name. When the value is empty (default), the generated 'balanced' graph will replace the original 'unbalanced' graph under the same graph name. The default value is ''.
• SOURCE_NODE: The distributed shortest path solve is run from this source node to all the nodes in the graph to create balaced partitions using the iso-distance levels of the solution. The source node is selected by the rebalance algorithm automatically (default case when the value is an empty string). Otherwise, the user specified node is used as the source. The default value is ''.
• SQL_REQUEST_AVRO_JSON: The default value is ''.

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