GetGraphEntitiesRequest.Options Struct Reference

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

Public Attributes
const string	ENTITY_TYPE = "entity_type"
	The type of entity to retrieve. More...
const string	EDGE = "edge"
	Retrieve edge entities (default). More...
const string	NODE = "node"
	Retrieve node entities. More...
const string	SERVER_ID = "server_id"
	Indicates which graph server to send the request to. More...
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). More...
const string	TRUE = "true"
	Populate entities_weight with per-edge weights (edge requests only). More...
const string	FALSE = "false"
	Default: entities_weight is empty. More...
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). More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 23 of file GetGraphEntities.cs.

Member Data Documentation

CONCISE_EDGE_CONNECTIVITY

const string GetGraphEntitiesRequest.Options.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).

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 77 of file GetGraphEntities.cs.

EDGE

const string GetGraphEntitiesRequest.Options.EDGE = "edge"

Retrieve edge entities (default).

Definition at line 43 of file GetGraphEntities.cs.

ENTITY_TYPE

const string GetGraphEntitiesRequest.Options.ENTITY_TYPE = "entity_type"

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 40 of file GetGraphEntities.cs.

FALSE

const string GetGraphEntitiesRequest.Options.FALSE = "false"

Default: entities_weight is empty.

Definition at line 87 of file GetGraphEntities.cs.

INCLUDE_WEIGHTS

const string GetGraphEntitiesRequest.Options.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).

Supported values:

• TRUE: Populate entities_weight with per-edge weights (edge requests only).
• FALSE: Default: entities_weight is empty.

The default value is FALSE.

Definition at line 115 of file GetGraphEntities.cs.

NODE

const string GetGraphEntitiesRequest.Options.NODE = "node"

Retrieve node entities.

Definition at line 46 of file GetGraphEntities.cs.

SERVER_ID

const string GetGraphEntitiesRequest.Options.SERVER_ID = "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'.

Definition at line 52 of file GetGraphEntities.cs.

TRUE

const string GetGraphEntitiesRequest.Options.TRUE = "true"

Populate entities_weight with per-edge weights (edge requests only).

Definition at line 82 of file GetGraphEntities.cs.

---

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

• Kinetica/Protocol/GetGraphEntities.cs