> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# kinetica.GetGraphEntitiesRequest.Options

> kinetica.GetGraphEntitiesRequest.Options — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesRequest#a3218261ee88d36847672f93eb61eb3f1" title="Optional parameters.">GetGraphEntitiesRequest.options</a>. <a href="#details">More...</a></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Static Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a22f7fb42650b5d29e08c8876bd072874" id="r_a22f7fb42650b5d29e08c8876bd072874">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a22f7fb42650b5d29e08c8876bd072874">ENTITY\_TYPE</a> = "entity\_type"</td>
      </tr>

      <tr className="memdesc:a22f7fb42650b5d29e08c8876bd072874">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The type of entity to retrieve. <br /></td>
      </tr>

      <tr className="separator:a22f7fb42650b5d29e08c8876bd072874">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a13513239dced4f7b1bd21577295295fb" id="r_a13513239dced4f7b1bd21577295295fb">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a13513239dced4f7b1bd21577295295fb">EDGE</a> = "edge"</td>
      </tr>

      <tr className="memdesc:a13513239dced4f7b1bd21577295295fb">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Retrieve edge entities (default). <br /></td>
      </tr>

      <tr className="separator:a13513239dced4f7b1bd21577295295fb">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a8f46b99cf42c527ecc944c594b6fddd5" id="r_a8f46b99cf42c527ecc944c594b6fddd5">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8f46b99cf42c527ecc944c594b6fddd5">NODE</a> = "node"</td>
      </tr>

      <tr className="memdesc:a8f46b99cf42c527ecc944c594b6fddd5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Retrieve node entities. <br /></td>
      </tr>

      <tr className="separator:a8f46b99cf42c527ecc944c594b6fddd5">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a856d6a64a7ee00fd3f480068a8054f47" id="r_a856d6a64a7ee00fd3f480068a8054f47">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a856d6a64a7ee00fd3f480068a8054f47">SERVER\_ID</a> = "server\_id"</td>
      </tr>

      <tr className="memdesc:a856d6a64a7ee00fd3f480068a8054f47">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Indicates which graph server to send the request to. <br /></td>
      </tr>

      <tr className="separator:a856d6a64a7ee00fd3f480068a8054f47">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a4c2e0380e2dc354e719c913431b4f384" id="r_a4c2e0380e2dc354e719c913431b4f384">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4c2e0380e2dc354e719c913431b4f384">CONCISE\_EDGE\_CONNECTIVITY</a> = "concise\_edge\_connectivity"</td>
      </tr>

      <tr className="memdesc:a4c2e0380e2dc354e719c913431b4f384">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a010e310c1ee1af0177145fa12bbf6ed0">entities\_int</a> 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). <br /></td>
      </tr>

      <tr className="separator:a4c2e0380e2dc354e719c913431b4f384">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ac1cafb4edf616293f91da9fceb4f914d" id="r_ac1cafb4edf616293f91da9fceb4f914d">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ac1cafb4edf616293f91da9fceb4f914d">TRUE</a> = "true"</td>
      </tr>

      <tr className="memdesc:ac1cafb4edf616293f91da9fceb4f914d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options" title="A set of string constants for the parameter GetGraphEntitiesRequest.options.">GetGraphEntitiesRequest.Options</a> options. <br /></td>
      </tr>

      <tr className="separator:ac1cafb4edf616293f91da9fceb4f914d">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ad138480185ca6a0609d73182b4035534" id="r_ad138480185ca6a0609d73182b4035534">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad138480185ca6a0609d73182b4035534">FALSE</a> = "false"</td>
      </tr>

      <tr className="memdesc:ad138480185ca6a0609d73182b4035534">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options" title="A set of string constants for the parameter GetGraphEntitiesRequest.options.">GetGraphEntitiesRequest.Options</a> options. <br /></td>
      </tr>

      <tr className="separator:ad138480185ca6a0609d73182b4035534">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a970f21dc62d55c608898091a97f99bf4" id="r_a970f21dc62d55c608898091a97f99bf4">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a970f21dc62d55c608898091a97f99bf4">INCLUDE\_WEIGHTS</a> = "include\_weights"</td>
      </tr>

      <tr className="memdesc:a970f21dc62d55c608898091a97f99bf4">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">When true and <code>options entity\_type</code> is 'edge', the response <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#aa358e0f3e7db2896a53903b509934e6a">entities\_weight</a> array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a010e310c1ee1af0177145fa12bbf6ed0">entities\_int</a> or <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a3e8dc2be8042c97bfe40861560405765">entities\_string</a>). <br /></td>
      </tr>

      <tr className="separator:a970f21dc62d55c608898091a97f99bf4">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesRequest#a3218261ee88d36847672f93eb61eb3f1" title="Optional parameters.">GetGraphEntitiesRequest.options</a>. </p>
      <p>Optional parameters.</p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source#l00023">23</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a>.</p>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a4c2e0380e2dc354e719c913431b4f384">◆ </a></span>CONCISE\_EDGE\_CONNECTIVITY</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.GetGraphEntitiesRequest.Options.CONCISE\_EDGE\_CONNECTIVITY = "concise\_edge\_connectivity"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a010e310c1ee1af0177145fa12bbf6ed0">entities\_int</a> 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). </p>
        <p>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 <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesRequest#ab468ac3f97007e349932a55ee6b89fe0" title="Starting index of the entities to retrieve (0-based).">GetGraphEntitiesRequest.offset</a> from an edge endpoint index to locate it within the returned page. Supported values:</p>

        <ul>
          <li> <a className="el" href="#ac1cafb4edf616293f91da9fceb4f914d">TRUE</a>: Compact integer connectivity for edges; deleted node slots included in node output. </li>
          <li> <a className="el" href="#ad138480185ca6a0609d73182b4035534">FALSE</a>: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped. </li>
        </ul>

        <p>The default value is <a className="el" href="#ad138480185ca6a0609d73182b4035534">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source#l00094">94</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a13513239dced4f7b1bd21577295295fb">◆ </a></span>EDGE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.GetGraphEntitiesRequest.Options.EDGE = "edge"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Retrieve edge entities (default). </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source#l00048">48</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a22f7fb42650b5d29e08c8876bd072874">◆ </a></span>ENTITY\_TYPE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.GetGraphEntitiesRequest.Options.ENTITY\_TYPE = "entity\_type"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The type of entity to retrieve. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a13513239dced4f7b1bd21577295295fb">EDGE</a>: Retrieve edge entities (default). </li>
          <li> <a className="el" href="#a8f46b99cf42c527ecc944c594b6fddd5">NODE</a>: Retrieve node entities. </li>
        </ul>

        <p>The default value is <a className="el" href="#a13513239dced4f7b1bd21577295295fb">EDGE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source#l00045">45</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ad138480185ca6a0609d73182b4035534">◆ </a></span>FALSE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.GetGraphEntitiesRequest.Options.FALSE = "false"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options" title="A set of string constants for the parameter GetGraphEntitiesRequest.options.">GetGraphEntitiesRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source#l00102">102</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a970f21dc62d55c608898091a97f99bf4">◆ </a></span>INCLUDE\_WEIGHTS</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.GetGraphEntitiesRequest.Options.INCLUDE\_WEIGHTS = "include\_weights"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>When true and <code>options entity\_type</code> is 'edge', the response <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#aa358e0f3e7db2896a53903b509934e6a">entities\_weight</a> array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a010e310c1ee1af0177145fa12bbf6ed0">entities\_int</a> or <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a3e8dc2be8042c97bfe40861560405765">entities\_string</a>). </p>
        <p>Empty when the graph has no weights component or when requesting nodes. Supported values:</p>

        <ul>
          <li> <a className="el" href="#ac1cafb4edf616293f91da9fceb4f914d">TRUE</a>: Populate <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#aa358e0f3e7db2896a53903b509934e6a">entities\_weight</a> with per-edge weights (edge requests only). </li>
          <li> <a className="el" href="#ad138480185ca6a0609d73182b4035534">FALSE</a>: Default: <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#aa358e0f3e7db2896a53903b509934e6a">entities\_weight</a> is empty. </li>
        </ul>

        <p>The default value is <a className="el" href="#ad138480185ca6a0609d73182b4035534">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source#l00137">137</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a8f46b99cf42c527ecc944c594b6fddd5">◆ </a></span>NODE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.GetGraphEntitiesRequest.Options.NODE = "node"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Retrieve node entities. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source#l00051">51</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a856d6a64a7ee00fd3f480068a8054f47">◆ </a></span>SERVER\_ID</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.GetGraphEntitiesRequest.Options.SERVER\_ID = "server\_id"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Indicates which graph server to send the request to. </p>
        <p>Required when the graph is distributed across multiple servers. The default value is '0'.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source#l00057">57</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ac1cafb4edf616293f91da9fceb4f914d">◆ </a></span>TRUE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.GetGraphEntitiesRequest.Options.TRUE = "true"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options" title="A set of string constants for the parameter GetGraphEntitiesRequest.options.">GetGraphEntitiesRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source#l00098">98</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <hr />

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

    <ul>
      <li>\_build/public-os\_ubuntu24.04-arch\_amd64-cc\_gcc\_13.3.0/install/Kinetica/Protocol/<a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a></li>
      <li>Kinetica/Protocol/<a className="el" href="/content/api/cs/Kinetica_2Protocol_2GetGraphEntities_8cs_source">GetGraphEntities.cs</a></li>
    </ul>
  </div>
</div>