Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.RepartitionGraphRequest Class Reference

A set of parameters for Kinetica.repartitionGraph(string,IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.RepartitionGraphRequest:
+ Collaboration diagram for kinetica.RepartitionGraphRequest:

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 RepartitionGraphRequest ()
 Constructs a RepartitionGraphRequest object with default parameters. More...
 
 RepartitionGraphRequest (string graph_name, IDictionary< string, string > options=null)
 Constructs a RepartitionGraphRequest object with the specified parameters. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

string graph_name [get, set]
 Name of the graph resource to rebalance. More...
 
IDictionary< string, string > options [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema SchemaFromType (System.Type t, KineticaType ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 

Detailed Description

A set of parameters for Kinetica.repartitionGraph(string,IDictionary{string, string}).


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

Definition at line 29 of file RepartitionGraph.cs.

Constructor & Destructor Documentation

kinetica.RepartitionGraphRequest.RepartitionGraphRequest ( )
inline

Constructs a RepartitionGraphRequest object with default parameters.

Definition at line 136 of file RepartitionGraph.cs.

kinetica.RepartitionGraphRequest.RepartitionGraphRequest ( string  graph_name,
IDictionary< string, string >  options = null 
)
inline

Constructs a RepartitionGraphRequest object with the specified parameters.

Parameters
graph_nameName of the graph resource to rebalance.
optionsOptional 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 Dictionary.

Definition at line 177 of file RepartitionGraph.cs.

Property Documentation

string kinetica.RepartitionGraphRequest.graph_name
getset

Name of the graph resource to rebalance.

Definition at line 96 of file RepartitionGraph.cs.

IDictionary<string, string> kinetica.RepartitionGraphRequest.options
getset

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

Definition at line 131 of file RepartitionGraph.cs.


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