Skip to main content

A set of parameters for Kinetica.repartitionGraph. More…

Inheritance diagram for kinetica.RepartitionGraphRequest:
[legend]
Collaboration diagram for kinetica.RepartitionGraphRequest:
[legend]

​
Classes

struct  Options
 A set of string constants for the parameter RepartitionGraphRequest.options. More…
 

​
Public Member Functions

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

​
Properties

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

​
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.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of parameters for Kinetica.repartitionGraph.

Rebalances an existing partitioned graph.

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

Definition at line 22 of file RepartitionGraph.cs.

​
Constructor & Destructor Documentation

​
◆ RepartitionGraphRequest() [1/4]

kinetica.RepartitionGraphRequest.RepartitionGraphRequest ()
 inline

Constructs a RepartitionGraphRequest object with default parameters.

Definition at line 81 of file RepartitionGraph.cs.

​
◆ RepartitionGraphRequest() [2/4]

kinetica.RepartitionGraphRequest.RepartitionGraphRequest (stringgraph_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 behavior) 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 balanced 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 ”.
The default value is an empty Dictionary.

Definition at line 115 of file RepartitionGraph.cs.

​
◆ RepartitionGraphRequest() [3/4]

kinetica.RepartitionGraphRequest.RepartitionGraphRequest ()
 inline

Constructs a RepartitionGraphRequest object with default parameters.

Definition at line 81 of file RepartitionGraph.cs.

​
◆ RepartitionGraphRequest() [4/4]

kinetica.RepartitionGraphRequest.RepartitionGraphRequest (stringgraph_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 behavior) 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 balanced 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 ”.
The default value is an empty Dictionary.

Definition at line 115 of file RepartitionGraph.cs.

​
Property Documentation

​
◆ graph_name

string kinetica.RepartitionGraphRequest.graph_name
 getset

Name of the graph resource to rebalance.

Definition at line 48 of file RepartitionGraph.cs.

​
◆ options

IDictionary< string, string > kinetica.RepartitionGraphRequest.options = new Dictionary<string, string>()
 getset

Optional parameters.

  • NEW_GRAPH_NAME: If a non-empty value is specified, the original graph will be kept (non-default behavior) 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 balanced 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 ”.

The default value is an empty Dictionary.

Definition at line 77 of file RepartitionGraph.cs.

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