Kinetica   C#   API  Version 7.2.3.0
kinetica.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...
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 23 of file GetGraphEntities.cs.

Member Data Documentation

◆ EDGE

const string kinetica.GetGraphEntitiesRequest.Options.EDGE = "edge"

Retrieve edge entities (default).

Definition at line 43 of file GetGraphEntities.cs.

◆ ENTITY_TYPE

const string kinetica.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.

◆ NODE

const string kinetica.GetGraphEntitiesRequest.Options.NODE = "node"

Retrieve node entities.

Definition at line 46 of file GetGraphEntities.cs.

◆ SERVER_ID

const string kinetica.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.


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