kinetica.GetGraphEntitiesRequest Class Reference

A set of parameters for Kinetica.getGraphEntities. More...

Inheritance diagram for kinetica.GetGraphEntitiesRequest:

Collaboration diagram for kinetica.GetGraphEntitiesRequest:

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

Public Member Functions
	GetGraphEntitiesRequest ()
	Constructs a GetGraphEntitiesRequest object with default parameters. More...
	GetGraphEntitiesRequest (string graph_name, long? offset=null, long? limit=null, IDictionary< string, string > options=null)
	Constructs a GetGraphEntitiesRequest 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...
	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 from which to retrieve entities. More...
long	offset = 0 [get, set]
	Starting index of the entities to retrieve (0-based). More...
long	limit = 10000 [get, set]
	Number of entities to retrieve starting from offset. More...
IDictionary< string, string >	options = new Dictionary<string, string>() [get, set]
	Optional parameters. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...
Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema [get]

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

Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use Kinetica.showGraph to obtain the total number of nodes and edges.

Definition at line 18 of file GetGraphEntities.cs.

Constructor & Destructor Documentation

GetGraphEntitiesRequest() [1/2]

kinetica.GetGraphEntitiesRequest.GetGraphEntitiesRequest ( )

inline

Constructs a GetGraphEntitiesRequest object with default parameters.

Definition at line 108 of file GetGraphEntities.cs.

GetGraphEntitiesRequest() [2/2]

kinetica.GetGraphEntitiesRequest.GetGraphEntitiesRequest ( string  graph_name, long?  offset = null, long?  limit = null, IDictionary< string, string >  options = null  )

inline

Constructs a GetGraphEntitiesRequest object with the specified parameters.

Parameters

graph_name	Name of the graph from which to retrieve entities.
offset	Starting index of the entities to retrieve (0-based). The default value is 0.
limit	Number of entities to retrieve starting from offset . A value of -1 returns all entities from the offset to the end. Note: the entities_int or entities_string array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.
options	Optional parameters. ENTITY_TYPE: The type of entity to retrieve. Supported values: EDGE: Retrieve edge entities (default). NODE: Retrieve node entities. The default value is EDGE. SERVER_ID: Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'. The default value is an empty Dictionary.

Definition at line 154 of file GetGraphEntities.cs.

Property Documentation

graph_name

string kinetica.GetGraphEntitiesRequest.graph_name

getset

Name of the graph from which to retrieve entities.

Definition at line 57 of file GetGraphEntities.cs.

limit

long kinetica.GetGraphEntitiesRequest.limit = 10000

getset

Number of entities to retrieve starting from offset.

A value of -1 returns all entities from the offset to the end. Note: the entities_int or entities_string array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.

Definition at line 73 of file GetGraphEntities.cs.

offset

long kinetica.GetGraphEntitiesRequest.offset = 0

getset

Starting index of the entities to retrieve (0-based).

The default value is 0.

Definition at line 62 of file GetGraphEntities.cs.

options

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

getset

Optional parameters.

• ENTITY_TYPE: The type of entity to retrieve. Supported values:
  • EDGE: Retrieve edge entities (default).
  • NODE: Retrieve node entities.
  The default value is EDGE.
• SERVER_ID: Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'.

The default value is an empty Dictionary.

Definition at line 104 of file GetGraphEntities.cs.

---

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

• Kinetica/Protocol/GetGraphEntities.cs