> ## 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#a37ec1bbc8971ca3dcc120bb062993b08" title="Optional parameters.">GetGraphEntitiesRequest.options</a>. <a href="#details">More...</a></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="pub-static-attribs" />

            Static Public Attributes
          </h2>
        </td>
      </tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

      <tr className="memdesc:a942e4039459dcd0e4d59a6dda7f034ba">
        <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#a0918e0b3dc528a9f583b47100dba0050">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:a942e4039459dcd0e4d59a6dda7f034ba">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:a729881db863cd441669109e620b04f09">
        <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:a729881db863cd441669109e620b04f09">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:a9a8a799f36db50bf0b9e30895b575081">
        <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:a9a8a799f36db50bf0b9e30895b575081">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:ae23ba6e89ce7293c44bd42e1ef9a553b">
        <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#a77b8de25ab1fef8f651930dd62cfdf2f">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#a0918e0b3dc528a9f583b47100dba0050">entities\_int</a> or <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a6edb5534e9fe54d3bebec5c2bc5a9ce1">entities\_string</a>). <br /></td>
      </tr>

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

    <div id="details" />

    <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#a37ec1bbc8971ca3dcc120bb062993b08" title="Optional parameters.">GetGraphEntitiesRequest.options</a>. </p>
      <p>Optional parameters.</p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L23">23</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs">GetGraphEntities.cs</a>.</p>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>

    <div id="a942e4039459dcd0e4d59a6dda7f034ba" />

    <h2 className="memtitle"><span className="permalink"><a href="#a942e4039459dcd0e4d59a6dda7f034ba">◆ </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#a0918e0b3dc528a9f583b47100dba0050">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#a06a839d8365eb1938fa930cc43960db5" 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="#a729881db863cd441669109e620b04f09">TRUE</a>: Compact integer connectivity for edges; deleted node slots included in node output. </li>
          <li> <a className="el" href="#a9a8a799f36db50bf0b9e30895b575081">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="#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L94">94</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <div id="ad94a349f438817c9d17a02cde081e2bd" />

    <h2 className="memtitle"><span className="permalink"><a href="#ad94a349f438817c9d17a02cde081e2bd">◆ </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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L48">48</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <div id="a957419437655c30894d20c22c7cfd72f" />

    <h2 className="memtitle"><span className="permalink"><a href="#a957419437655c30894d20c22c7cfd72f">◆ </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="#ad94a349f438817c9d17a02cde081e2bd">EDGE</a>: Retrieve edge entities (default). </li>
          <li> <a className="el" href="#a1ee16bd661daa23f5f3fedf0fb558908">NODE</a>: Retrieve node entities. </li>
        </ul>

        <p>The default value is <a className="el" href="#ad94a349f438817c9d17a02cde081e2bd">EDGE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L45">45</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <div id="a9a8a799f36db50bf0b9e30895b575081" />

    <h2 className="memtitle"><span className="permalink"><a href="#a9a8a799f36db50bf0b9e30895b575081">◆ </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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L102">102</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <div id="ae23ba6e89ce7293c44bd42e1ef9a553b" />

    <h2 className="memtitle"><span className="permalink"><a href="#ae23ba6e89ce7293c44bd42e1ef9a553b">◆ </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#a77b8de25ab1fef8f651930dd62cfdf2f">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#a0918e0b3dc528a9f583b47100dba0050">entities\_int</a> or <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a6edb5534e9fe54d3bebec5c2bc5a9ce1">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="#a729881db863cd441669109e620b04f09">TRUE</a>: Populate <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a77b8de25ab1fef8f651930dd62cfdf2f">entities\_weight</a> with per-edge weights (edge requests only). </li>
          <li> <a className="el" href="#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>: Default: <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a77b8de25ab1fef8f651930dd62cfdf2f">entities\_weight</a> is empty. </li>
        </ul>

        <p>The default value is <a className="el" href="#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L137">137</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <div id="a1ee16bd661daa23f5f3fedf0fb558908" />

    <h2 className="memtitle"><span className="permalink"><a href="#a1ee16bd661daa23f5f3fedf0fb558908">◆ </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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L51">51</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <div id="afc2a88101123aa8c065be1658c2d5503" />

    <h2 className="memtitle"><span className="permalink"><a href="#afc2a88101123aa8c065be1658c2d5503">◆ </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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L57">57</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <div id="a729881db863cd441669109e620b04f09" />

    <h2 className="memtitle"><span className="permalink"><a href="#a729881db863cd441669109e620b04f09">◆ </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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L98">98</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs">GetGraphEntities.cs</a>.</p>
      </div>
    </div>

    <hr />

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

    <ul>
      <li>Kinetica/Protocol/<a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs">GetGraphEntities.cs</a></li>
    </ul>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.