> ## 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

> kinetica.GetGraphEntitiesRequest — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica/getgraphentities#a045557ec0e632141f37c9d5cd9fcf903">Kinetica.getGraphEntities</a>. <a href="#details">More...</a></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="nested-classes" />

            Classes
          </h2>
        </td>
      </tr>

      <tr className="memitem:">
        <td className="memItemLeft" align="right" valign="top">struct  </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options">Options</a></td>
      </tr>

      <tr className="memdesc:">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A set of string constants for the parameter <a className="el" href="#a37ec1bbc8971ca3dcc120bb062993b08" title="Optional parameters.">GetGraphEntitiesRequest.options</a>. <a href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#details">More...</a><br /></td>
      </tr>

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

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

            Public Member Functions
          </h2>
        </td>
      </tr>

      <tr className="memitem:a705e931f3184e5d34ef927baad8e35e1" id="r_a705e931f3184e5d34ef927baad8e35e1">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a705e931f3184e5d34ef927baad8e35e1">GetGraphEntitiesRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a705e931f3184e5d34ef927baad8e35e1">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesRequest" title="A set of parameters for Kinetica.getGraphEntities.">GetGraphEntitiesRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a80056803e89c7e21fb4e03fbcc3aa49f" id="r_a80056803e89c7e21fb4e03fbcc3aa49f">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a80056803e89c7e21fb4e03fbcc3aa49f">GetGraphEntitiesRequest</a> (string <a className="el" href="#a719d5616960fad6370456c396183b936">graph\_name</a>, long? <a className="el" href="#a06a839d8365eb1938fa930cc43960db5">offset</a>=null, long? <a className="el" href="#aef86c68202b6577a5a5858675e649287">limit</a>=null, IDictionary\< string, string > <a className="el" href="#a37ec1bbc8971ca3dcc120bb062993b08">options</a>=null)</td>
      </tr>

      <tr className="memdesc:a80056803e89c7e21fb4e03fbcc3aa49f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesRequest" title="A set of parameters for Kinetica.getGraphEntities.">GetGraphEntitiesRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="inherit_header pub_methods_classkinetica_1_1KineticaData">
        <td colSpan="2"> Public Member Functions inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData" id="r_a6a494237f126f79a7f478b7614323482">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a6a494237f126f79a7f478b7614323482">KineticaData</a> (<a className="el" href="/content/api/cs/classkinetica_1_1KineticaType">KineticaType</a> type)</td>
      </tr>

      <tr className="memdesc:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructor from <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> Type. <br /></td>
      </tr>

      <tr className="separator:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData" id="r_ac8cbdce08f2dd7d0d02bf0f279d79b79">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ac8cbdce08f2dd7d0d02bf0f279d79b79">KineticaData</a> (System.Type type=null)</td>
      </tr>

      <tr className="memdesc:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Default constructor, with optional System.Type. <br /></td>
      </tr>

      <tr className="separator:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData" id="r_a8fceb0fc6b641ef28b7548bc2820e48f">
        <td className="memItemLeft" align="right" valign="top">object </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a8fceb0fc6b641ef28b7548bc2820e48f">Get</a> (int fieldPos)</td>
      </tr>

      <tr className="memdesc:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Retrieve a specific property from this object. <br /></td>
      </tr>

      <tr className="separator:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData" id="r_ad02b0bac0aa3f8a64b0ec46a94bd06f0">
        <td className="memItemLeft" align="right" valign="top">void </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ad02b0bac0aa3f8a64b0ec46a94bd06f0">Put</a> (int fieldPos, object fieldValue)</td>
      </tr>

      <tr className="memdesc:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Write a specific property to this object. <br /></td>
      </tr>

      <tr className="separator:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="properties" />

            Properties
          </h2>
        </td>
      </tr>

      <tr className="memitem:a719d5616960fad6370456c396183b936" id="r_a719d5616960fad6370456c396183b936">
        <td className="memItemLeft" align="right" valign="top">string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a719d5616960fad6370456c396183b936">graph\_name</a><code> \[get, set]</code></td>
      </tr>

      <tr className="memdesc:a719d5616960fad6370456c396183b936">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the graph from which to retrieve entities. <br /></td>
      </tr>

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

      <tr className="memitem:a06a839d8365eb1938fa930cc43960db5" id="r_a06a839d8365eb1938fa930cc43960db5">
        <td className="memItemLeft" align="right" valign="top">long </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a06a839d8365eb1938fa930cc43960db5">offset</a> = 0<code> \[get, set]</code></td>
      </tr>

      <tr className="memdesc:a06a839d8365eb1938fa930cc43960db5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Starting index of the entities to retrieve (0-based). <br /></td>
      </tr>

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

      <tr className="memitem:aef86c68202b6577a5a5858675e649287" id="r_aef86c68202b6577a5a5858675e649287">
        <td className="memItemLeft" align="right" valign="top">long </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aef86c68202b6577a5a5858675e649287">limit</a> = 10000<code> \[get, set]</code></td>
      </tr>

      <tr className="memdesc:aef86c68202b6577a5a5858675e649287">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Number of entities to retrieve starting from <a className="el" href="#a06a839d8365eb1938fa930cc43960db5" title="Starting index of the entities to retrieve (0-based).">GetGraphEntitiesRequest.offset</a>. <br /></td>
      </tr>

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

      <tr className="memitem:a37ec1bbc8971ca3dcc120bb062993b08" id="r_a37ec1bbc8971ca3dcc120bb062993b08">
        <td className="memItemLeft" align="right" valign="top">IDictionary\< string, string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a37ec1bbc8971ca3dcc120bb062993b08">options</a> = new Dictionary\<string, string>()<code> \[get, set]</code></td>
      </tr>

      <tr className="memdesc:a37ec1bbc8971ca3dcc120bb062993b08">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

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

      <tr className="inherit_header properties_classkinetica_1_1KineticaData">
        <td colSpan="2"> Properties inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:ae35f20177341ed020cb1c92195621499 inherit properties_classkinetica_1_1KineticaData" id="r_ae35f20177341ed020cb1c92195621499">
        <td className="memItemLeft" align="right" valign="top">Schema </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ae35f20177341ed020cb1c92195621499">Schema</a><code> \[get]</code></td>
      </tr>

      <tr className="memdesc:ae35f20177341ed020cb1c92195621499 inherit properties_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Avro Schema for this class. <br /></td>
      </tr>

      <tr className="separator:ae35f20177341ed020cb1c92195621499 inherit properties_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="inherited" />

            Additional Inherited Members
          </h2>
        </td>
      </tr>

      <tr className="inherit_header pub_static_methods_classkinetica_1_1KineticaData">
        <td colSpan="2"> Static Public Member Functions inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData" id="r_a9474d49c9399dbe86f31a3ba07ff4691">
        <td className="memItemLeft" align="right" valign="top">static ? RecordSchema </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a9474d49c9399dbe86f31a3ba07ff4691">SchemaFromType</a> (System.Type t, <a className="el" href="/content/api/cs/classkinetica_1_1KineticaType">KineticaType</a>? ktype=null)</td>
      </tr>

      <tr className="memdesc:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Create an Avro Schema from a System.Type and a <a className="el" href="/content/api/cs/classkinetica_1_1KineticaType" title="Describes a Kinetica record type — its columns, properties, and Avro schema — and can create the type...">KineticaType</a>. <br /></td>
      </tr>

      <tr className="separator:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <div id="details" />

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

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica/getgraphentities#a045557ec0e632141f37c9d5cd9fcf903">Kinetica.getGraphEntities</a>. </p>
      <p>Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica/showgraph#a58f4cd71a9f4d877d262fbf790d31a3c">Kinetica.showGraph</a> to obtain the total number of nodes and edges.</p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L18">18</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">Constructor & Destructor Documentation</h2>

    <div id="a705e931f3184e5d34ef927baad8e35e1" />

    <h2 className="memtitle"><span className="permalink"><a href="#a705e931f3184e5d34ef927baad8e35e1">◆ </a></span>GetGraphEntitiesRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">kinetica.GetGraphEntitiesRequest.GetGraphEntitiesRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesRequest" title="A set of parameters for Kinetica.getGraphEntities.">GetGraphEntitiesRequest</a> object with default 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#L278">278</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="a80056803e89c7e21fb4e03fbcc3aa49f" />

    <h2 className="memtitle"><span className="permalink"><a href="#a80056803e89c7e21fb4e03fbcc3aa49f">◆ </a></span>GetGraphEntitiesRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">kinetica.GetGraphEntitiesRequest.GetGraphEntitiesRequest </td>
                  <td>(</td>
                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">graph\_name</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">long?</td>
                  <td className="paramname"><span className="paramname"><span className="em">offset</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">long?</td>
                  <td className="paramname"><span className="paramname"><span className="em">limit</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">IDictionary\< string, string ></td>
                  <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span> )</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesRequest" title="A set of parameters for Kinetica.getGraphEntities.">GetGraphEntitiesRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramname">graph\_name</td>
                <td>Name of the graph from which to retrieve entities.</td>
              </tr>

              <tr>
                <td className="paramname">offset</td>
                <td>Starting index of the entities to retrieve (0-based). The default value is 0.</td>
              </tr>

              <tr>
                <td className="paramname">limit</td>
                <td>Number of entities to retrieve starting from <span className="em">offset</span> . A value of -1 returns all entities from the offset to the end. Note: the <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> array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.</td>
              </tr>

              <tr>
                <td className="paramname">options</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a957419437655c30894d20c22c7cfd72f">ENTITY\_TYPE</a>: The type of entity to retrieve. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ad94a349f438817c9d17a02cde081e2bd">EDGE</a>: Retrieve edge entities (default). </li>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a1ee16bd661daa23f5f3fedf0fb558908">NODE</a>: Retrieve node entities. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ad94a349f438817c9d17a02cde081e2bd">EDGE</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#afc2a88101123aa8c065be1658c2d5503">SERVER\_ID</a>: Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'. </li>

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a942e4039459dcd0e4d59a6dda7f034ba">CONCISE\_EDGE\_CONNECTIVITY</a>: 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). 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 <span className="em">offset</span> from an edge endpoint index to locate it within the returned page. Supported values:

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

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ae23ba6e89ce7293c44bd42e1ef9a553b">INCLUDE\_WEIGHTS</a>: 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>). Empty when the graph has no weights component or when requesting nodes. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#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="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>: Default: <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a77b8de25ab1fef8f651930dd62cfdf2f">entities\_weight</a> is empty. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>.
                    </li>
                  </ul>

                  The default value is an empty Dictionary.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L410">410</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>

    <h2 className="groupheader">Property Documentation</h2>

    <div id="a719d5616960fad6370456c396183b936" />

    <h2 className="memtitle"><span className="permalink"><a href="#a719d5616960fad6370456c396183b936">◆ </a></span>graph\_name</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">string kinetica.GetGraphEntitiesRequest.graph\_name</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Name of the graph from which to retrieve 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#L141">141</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="aef86c68202b6577a5a5858675e649287" />

    <h2 className="memtitle"><span className="permalink"><a href="#aef86c68202b6577a5a5858675e649287">◆ </a></span>limit</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">long kinetica.GetGraphEntitiesRequest.limit = 10000</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Number of entities to retrieve starting from <a className="el" href="#a06a839d8365eb1938fa930cc43960db5" title="Starting index of the entities to retrieve (0-based).">GetGraphEntitiesRequest.offset</a>. </p>
        <p>A value of -1 returns all entities from the offset to the end. Note: the <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> array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L156">156</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="a06a839d8365eb1938fa930cc43960db5" />

    <h2 className="memtitle"><span className="permalink"><a href="#a06a839d8365eb1938fa930cc43960db5">◆ </a></span>offset</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">long kinetica.GetGraphEntitiesRequest.offset = 0</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Starting index of the entities to retrieve (0-based). </p>
        <p>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#L146">146</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="a37ec1bbc8971ca3dcc120bb062993b08" />

    <h2 className="memtitle"><span className="permalink"><a href="#a37ec1bbc8971ca3dcc120bb062993b08">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">IDictionary\<string, string> kinetica.GetGraphEntitiesRequest.options = new Dictionary\<string, string>()</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Optional parameters. </p>

        <ul>
          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a957419437655c30894d20c22c7cfd72f">ENTITY\_TYPE</a>: The type of entity to retrieve. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ad94a349f438817c9d17a02cde081e2bd">EDGE</a>: Retrieve edge entities (default). </li>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a1ee16bd661daa23f5f3fedf0fb558908">NODE</a>: Retrieve node entities. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ad94a349f438817c9d17a02cde081e2bd">EDGE</a>.
          </li>

          <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#afc2a88101123aa8c065be1658c2d5503">SERVER\_ID</a>: Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'. </li>

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a942e4039459dcd0e4d59a6dda7f034ba">CONCISE\_EDGE\_CONNECTIVITY</a>: 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). 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="#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:

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

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#ae23ba6e89ce7293c44bd42e1ef9a553b">INCLUDE\_WEIGHTS</a>: 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>). Empty when the graph has no weights component or when requesting nodes. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#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="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>: Default: <a className="el" href="/content/api/cs/classkinetica_1_1GetGraphEntitiesResponse#a77b8de25ab1fef8f651930dd62cfdf2f">entities\_weight</a> is empty. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetGraphEntitiesRequest_1_1Options#a9a8a799f36db50bf0b9e30895b575081">FALSE</a>.
          </li>
        </ul>

        <p>The default value is an empty Dictionary.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/GetGraphEntities.cs#L274">274</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 class 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.