Skip to main content

A set of string constants for the parameter GetGraphEntitiesRequest.options. More…

​
Static Public Attributes

const string ENTITY_TYPE = “entity_type”
 The type of entity to retrieve.
 
const string EDGE = “edge”
 Retrieve edge entities (default).
 
const string NODE = “node”
 Retrieve node entities.
 
const string SERVER_ID = “server_id”
 Indicates which graph server to send the request to.
 
const string CONCISE_EDGE_CONNECTIVITY = “concise_edge_connectivity”
 When true, edges are emitted in a compact connectivity form regardless of the graph’s identifier type: entities_int contains stride-4 records [edge_id, node1_index, node2_index, edge_label_index] where node1_index/node2_index are 0-based positions into the node array (obtained from a node-entity call on the same graph).
 
const string TRUE = “true”
 A boolean constant for the GetGraphEntitiesRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the GetGraphEntitiesRequest.Options options.
 
const string INCLUDE_WEIGHTS = “include_weights”
 When true and options entity_type is ‘edge’, the response entities_weight array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in entities_int or entities_string).
 

​
Detailed Description

A set of string constants for the parameter GetGraphEntitiesRequest.options.

Optional parameters.

Definition at line 23 of file GetGraphEntities.cs.

​
Member Data Documentation

​
◆ CONCISE_EDGE_CONNECTIVITY

const string kinetica.GetGraphEntitiesRequest.Options.CONCISE_EDGE_CONNECTIVITY = “concise_edge_connectivity”
 static

When true, edges are emitted in a compact connectivity form regardless of the graph’s identifier type: entities_int contains stride-4 records [edge_id, node1_index, node2_index, edge_label_index] where node1_index/node2_index are 0-based positions into the node array (obtained from a node-entity call on the same graph).

When requesting nodes with this option, the response includes tombstoned (deleted) slots in order to keep position indices stable so edge indices resolve correctly; deleted slots carry id=0 for integer graphs or an empty identifier for string/WKT graphs. For paginated node calls, subtract GetGraphEntitiesRequest.offset from an edge endpoint index to locate it within the returned page. Supported values:

  • TRUE: Compact integer connectivity for edges; deleted node slots included in node output.
  • FALSE: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped.

The default value is FALSE.

Definition at line 94 of file GetGraphEntities.cs.

​
◆ EDGE

const string kinetica.GetGraphEntitiesRequest.Options.EDGE = “edge”
 static

Retrieve edge entities (default).

Definition at line 48 of file GetGraphEntities.cs.

​
◆ ENTITY_TYPE

const string kinetica.GetGraphEntitiesRequest.Options.ENTITY_TYPE = “entity_type”
 static

The type of entity to retrieve.

Supported values:

  • EDGE: Retrieve edge entities (default).
  • NODE: Retrieve node entities.

The default value is EDGE.

Definition at line 45 of file GetGraphEntities.cs.

​
◆ FALSE

const string kinetica.GetGraphEntitiesRequest.Options.FALSE = “false”
 static

A boolean constant for the GetGraphEntitiesRequest.Options options.

Definition at line 102 of file GetGraphEntities.cs.

​
◆ INCLUDE_WEIGHTS

const string kinetica.GetGraphEntitiesRequest.Options.INCLUDE_WEIGHTS = “include_weights”
 static

When true and options entity_type is ‘edge’, the response entities_weight array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in entities_int or entities_string).

Empty when the graph has no weights component or when requesting nodes. Supported values:

The default value is FALSE.

Definition at line 137 of file GetGraphEntities.cs.

​
◆ NODE

const string kinetica.GetGraphEntitiesRequest.Options.NODE = “node”
 static

Retrieve node entities.

Definition at line 51 of file GetGraphEntities.cs.

​
◆ SERVER_ID

const string kinetica.GetGraphEntitiesRequest.Options.SERVER_ID = “server_id”
 static

Indicates which graph server to send the request to.

Required when the graph is distributed across multiple servers. The default value is ‘0’.

Definition at line 57 of file GetGraphEntities.cs.

​
◆ TRUE

const string kinetica.GetGraphEntitiesRequest.Options.TRUE = “true”
 static

A boolean constant for the GetGraphEntitiesRequest.Options options.

Definition at line 98 of file GetGraphEntities.cs.

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