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

# GetGraphEntitiesRequest

> GetGraphEntitiesRequest — Kinetica Java API

<div className="kinetica-javadoc">
  <div className="header">
    <div className="sub-title"><span className="package-label-in-type">Package</span> <a href="/content/api/java/com/gpudb/protocol/package-summary">com.gpudb.protocol</a></div>
    <h1 title="Class GetGraphEntitiesRequest" className="title">Class GetGraphEntitiesRequest</h1>
  </div>

  <div className="inheritance" title="Inheritance Tree">
    <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">java.lang.Object</a>
    <div className="inheritance">com.gpudb.protocol.GetGraphEntitiesRequest</div>
  </div>

  <div className="section class-description" id="class-description">
    <div className="dl notes">
      <div className="dt">All Implemented Interfaces:</div>
      <div className="dd"><code>org.apache.avro.generic.GenericContainer</code>, <code>org.apache.avro.generic.IndexedRecord</code></div>
    </div>

    <hr />

    <div className="type-signature"><span className="modifiers">public class </span><span className="element-name type-name-label">GetGraphEntitiesRequest</span> <span className="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a> implements org.apache.avro.generic.IndexedRecord</span></div>

    <div className="block">
      A set of parameters for <a href="/content/api/java/com/gpudb/GPUdb#getGraphEntities(com.gpudb.protocol.GetGraphEntitiesRequest)"><code>GPUdb.getGraphEntities</code></a>.
      <p> Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use <a href="/content/api/java/com/gpudb/GPUdb#showGraph(com.gpudb.protocol.ShowGraphRequest)"><code>GPUdb.showGraph</code></a> to obtain the total number of nodes and edges.</p>
    </div>
  </div>

  <div className="section summary">
    <ul className="summary-list">
      <li>
        <div className="section nested-class-summary" id="nested-class-summary">
          <h2>Nested Class Summary</h2>
          <div className="caption"><span>Nested Classes</span></div>

          <div className="summary-table three-column-summary">
            <div className="table-header col-first">Modifier and Type</div>
            <div className="table-header col-second">Class</div>
            <div className="table-header col-last">Description</div>
            <div className="col-first even-row-color"><code>static final class </code></div>
            <div className="col-second even-row-color"><code><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options" className="type-name-link" title="class in com.gpudb.protocol">GetGraphEntitiesRequest.Options</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">A set of string constants for the <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest" title="class in com.gpudb.protocol"><code>GetGraphEntitiesRequest</code></a> parameter <a href="#getOptions()"><code>options</code></a>.</div>
            </div>
          </div>
        </div>
      </li>

      <li>
        <div className="section constructor-summary" id="constructor-summary">
          <h2>Constructor Summary</h2>
          <div className="caption"><span>Constructors</span></div>

          <div className="summary-table two-column-summary">
            <div className="table-header col-first">Constructor</div>
            <div className="table-header col-last">Description</div>
            <div className="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" className="member-name-link">GetGraphEntitiesRequest</a>()</code></div>

            <div className="col-last even-row-color">
              <div className="block">Constructs a GetGraphEntitiesRequest object with default parameters.</div>
            </div>

            <div className="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,long,long,java.util.Map)" className="member-name-link">GetGraphEntitiesRequest</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> graphName, long offset, long limit, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</code></div>

            <div className="col-last odd-row-color">
              <div className="block">Constructs a GetGraphEntitiesRequest object with the specified parameters.</div>
            </div>
          </div>
        </div>
      </li>

      <li>
        <div className="section method-summary" id="method-summary">
          <h2>Method Summary</h2>

          <div id="method-summary-table">
            <div className="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabIndex="0" className="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabIndex="-1" className="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabIndex="-1" className="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabIndex="-1" className="table-tab">Concrete Methods</button></div>

            <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
              <div className="summary-table three-column-summary">
                <div className="table-header col-first">Modifier and Type</div>
                <div className="table-header col-second">Method</div>
                <div className="table-header col-last">Description</div>
                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" className="member-name-link">equals</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a> obj)</code></div>
                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(int)" className="member-name-link">get</a><wbr />(int index)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">This method supports the Avro framework and is not intended to be called directly by the user.</div>
                </div>

                <div className="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.avro.Schema</code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getClassSchema()" className="member-name-link">getClassSchema</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
                  <div className="block">This method supports the Avro framework and is not intended to be called directly by the user.</div>
                </div>

                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGraphName()" className="member-name-link">getGraphName</a>()</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name of the graph from which to retrieve entities.</div>
                </div>

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLimit()" className="member-name-link">getLimit</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Number of entities to retrieve starting from <a href="#getOffset()"><code>offset</code></a>.</div>
                </div>

                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOffset()" className="member-name-link">getOffset</a>()</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Starting index of the entities to retrieve (0-based).</div>
                </div>

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a><wbr />\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOptions()" className="member-name-link">getOptions</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Optional parameters.</div>
                </div>

                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.avro.Schema</code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSchema()" className="member-name-link">getSchema</a>()</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">This method supports the Avro framework and is not intended to be called directly by the user.</div>
                </div>

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" className="member-name-link">hashCode</a>()</code></div>
                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#put(int,java.lang.Object)" className="member-name-link">put</a><wbr />(int index, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a> value)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">This method supports the Avro framework and is not intended to be called directly by the user.</div>
                </div>

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest" title="class in com.gpudb.protocol">GetGraphEntitiesRequest</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setGraphName(java.lang.String)" className="member-name-link">setGraphName</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> graphName)</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name of the graph from which to retrieve entities.</div>
                </div>

                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest" title="class in com.gpudb.protocol">GetGraphEntitiesRequest</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLimit(long)" className="member-name-link">setLimit</a><wbr />(long limit)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Number of entities to retrieve starting from <a href="#getOffset()"><code>offset</code></a>.</div>
                </div>

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest" title="class in com.gpudb.protocol">GetGraphEntitiesRequest</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOffset(long)" className="member-name-link">setOffset</a><wbr />(long offset)</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Starting index of the entities to retrieve (0-based).</div>
                </div>

                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest" title="class in com.gpudb.protocol">GetGraphEntitiesRequest</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOptions(java.util.Map)" className="member-name-link">setOptions</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Optional parameters.</div>
                </div>

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" className="member-name-link">toString</a>()</code></div>
                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
              </div>
            </div>
          </div>

          <div className="inherited-list">
            <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></h3>
            <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" className="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" className="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" className="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" className="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" className="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" className="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" className="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" className="external-link">wait</a></code>
          </div>
        </div>
      </li>
    </ul>
  </div>

  <div className="section details">
    <ul className="details-list">
      <li>
        <div className="section constructor-details" id="constructor-detail">
          <h2>Constructor Details</h2>

          <ul className="member-list">
            <li>
              <div className="section detail" id="<init>()">
                <h3>GetGraphEntitiesRequest</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">GetGraphEntitiesRequest</span>()</div>
                <div className="block">Constructs a GetGraphEntitiesRequest object with default parameters.</div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(java.lang.String,long,long,java.util.Map)">
                <h3>GetGraphEntitiesRequest</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">GetGraphEntitiesRequest</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> graphName, long offset, long limit, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span></div>
                <div className="block">Constructs a GetGraphEntitiesRequest object with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>graphName</code> - Name of the graph from which to retrieve entities.</div>
                  <div className="dd"><code>offset</code> - Starting index of the entities to retrieve (0-based). The default value is 0.</div>
                  <div className="dd"><code>limit</code> - Number of entities to retrieve starting from <code> offset</code>. A value of -1 returns all entities from the offset to the end. Note: the <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesInt()"><code>entitiesInt</code></a> or <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesString()"><code>entitiesString</code></a> array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.</div>

                  <div className="dd">
                    <code>options</code> - Optional parameters.

                    <ul>
                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#ENTITY_TYPE"><code>ENTITY\_TYPE</code></a>: The type of entity to retrieve. Supported values:

                        <ul>
                          <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#EDGE"><code>EDGE</code></a>: Retrieve edge entities (default). </li>
                          <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#NODE"><code>NODE</code></a>: Retrieve node entities. </li>
                        </ul>

                        The default value is <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#EDGE"><code>EDGE</code></a>.
                      </li>

                      <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#SERVER_ID"><code>SERVER\_ID</code></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 href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#CONCISE_EDGE_CONNECTIVITY"><code>CONCISE\_EDGE\_CONNECTIVITY</code></a>: When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesInt()"><code>entitiesInt</code></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 <code>offset</code> from an edge endpoint index to locate it within the returned page. Supported values:

                        <ul>
                          <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#TRUE"><code>TRUE</code></a>: Compact integer connectivity for edges; deleted node slots included in node output. </li>
                          <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped. </li>
                        </ul>

                        The default value is <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>.
                      </li>

                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#INCLUDE_WEIGHTS"><code>INCLUDE\_WEIGHTS</code></a>: When true and <code>options entityType</code> is 'edge', the response <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesInt()"><code>entitiesInt</code></a> or <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesString()"><code>entitiesString</code></a>). Empty when the graph has no weights component or when requesting nodes. Supported values:

                        <ul>
                          <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#TRUE"><code>TRUE</code></a>: Populate <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> with per-edge weights (edge requests only). </li>
                          <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>: Default: <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> is empty. </li>
                        </ul>

                        The default value is <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>.
                      </li>
                    </ul>

                    The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
                  </div>
                </div>
              </div>
            </li>
          </ul>
        </div>
      </li>

      <li>
        <div className="section method-details" id="method-detail">
          <h2>Method Details</h2>

          <ul className="member-list">
            <li>
              <div className="section detail" id="getClassSchema()">
                <h3>getClassSchema</h3>
                <div className="member-signature"><span className="modifiers">public static</span> <span className="return-type">org.apache.avro.Schema</span> <span className="element-name">getClassSchema</span>()</div>
                <div className="block">This method supports the Avro framework and is not intended to be called directly by the user.</div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">The schema for the class.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getGraphName()">
                <h3>getGraphName</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">getGraphName</span>()</div>
                <div className="block">Name of the graph from which to retrieve entities.</div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">The current value of <code>graphName</code>.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="setGraphName(java.lang.String)">
                <h3>setGraphName</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest" title="class in com.gpudb.protocol">GetGraphEntitiesRequest</a></span> <span className="element-name">setGraphName</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> graphName)</span></div>
                <div className="block">Name of the graph from which to retrieve entities.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>graphName</code> - The new value for <code>graphName</code>.</div>
                  <div className="dt">Returns:</div>
                  <div className="dd"><code>this</code> to mimic the builder pattern.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getOffset()">
                <h3>getOffset</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type">long</span> <span className="element-name">getOffset</span>()</div>
                <div className="block">Starting index of the entities to retrieve (0-based). The default value is 0.</div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">The current value of <code>offset</code>.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="setOffset(long)">
                <h3>setOffset</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest" title="class in com.gpudb.protocol">GetGraphEntitiesRequest</a></span> <span className="element-name">setOffset</span><wbr /><span className="parameters">(long offset)</span></div>
                <div className="block">Starting index of the entities to retrieve (0-based). The default value is 0.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>offset</code> - The new value for <code>offset</code>.</div>
                  <div className="dt">Returns:</div>
                  <div className="dd"><code>this</code> to mimic the builder pattern.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getLimit()">
                <h3>getLimit</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type">long</span> <span className="element-name">getLimit</span>()</div>
                <div className="block">Number of entities to retrieve starting from <a href="#getOffset()"><code>offset</code></a>. A value of -1 returns all entities from the offset to the end. Note: the <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesInt()"><code>entitiesInt</code></a> or <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesString()"><code>entitiesString</code></a> array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.</div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">The current value of <code>limit</code>.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="setLimit(long)">
                <h3>setLimit</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest" title="class in com.gpudb.protocol">GetGraphEntitiesRequest</a></span> <span className="element-name">setLimit</span><wbr /><span className="parameters">(long limit)</span></div>
                <div className="block">Number of entities to retrieve starting from <a href="#getOffset()"><code>offset</code></a>. A value of -1 returns all entities from the offset to the end. Note: the <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesInt()"><code>entitiesInt</code></a> or <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesString()"><code>entitiesString</code></a> array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>limit</code> - The new value for <code>limit</code>.</div>
                  <div className="dt">Returns:</div>
                  <div className="dd"><code>this</code> to mimic the builder pattern.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getOptions()">
                <h3>getOptions</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>></span> <span className="element-name">getOptions</span>()</div>

                <div className="block">
                  Optional parameters.

                  <ul>
                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#ENTITY_TYPE"><code>ENTITY\_TYPE</code></a>: The type of entity to retrieve. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#EDGE"><code>EDGE</code></a>: Retrieve edge entities (default). </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#NODE"><code>NODE</code></a>: Retrieve node entities. </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#EDGE"><code>EDGE</code></a>.
                    </li>

                    <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#SERVER_ID"><code>SERVER\_ID</code></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 href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#CONCISE_EDGE_CONNECTIVITY"><code>CONCISE\_EDGE\_CONNECTIVITY</code></a>: When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesInt()"><code>entitiesInt</code></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 href="#getOffset()"><code>offset</code></a> from an edge endpoint index to locate it within the returned page. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#TRUE"><code>TRUE</code></a>: Compact integer connectivity for edges; deleted node slots included in node output. </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped. </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>.
                    </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#INCLUDE_WEIGHTS"><code>INCLUDE\_WEIGHTS</code></a>: When true and <code>options entityType</code> is 'edge', the response <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesInt()"><code>entitiesInt</code></a> or <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesString()"><code>entitiesString</code></a>). Empty when the graph has no weights component or when requesting nodes. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#TRUE"><code>TRUE</code></a>: Populate <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> with per-edge weights (edge requests only). </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>: Default: <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> is empty. </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>.
                    </li>
                  </ul>

                  The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">The current value of <code>options</code>.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="setOptions(java.util.Map)">
                <h3>setOptions</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest" title="class in com.gpudb.protocol">GetGraphEntitiesRequest</a></span> <span className="element-name">setOptions</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span></div>

                <div className="block">
                  Optional parameters.

                  <ul>
                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#ENTITY_TYPE"><code>ENTITY\_TYPE</code></a>: The type of entity to retrieve. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#EDGE"><code>EDGE</code></a>: Retrieve edge entities (default). </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#NODE"><code>NODE</code></a>: Retrieve node entities. </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#EDGE"><code>EDGE</code></a>.
                    </li>

                    <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#SERVER_ID"><code>SERVER\_ID</code></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 href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#CONCISE_EDGE_CONNECTIVITY"><code>CONCISE\_EDGE\_CONNECTIVITY</code></a>: When true, edges are emitted in a compact connectivity form regardless of the graph's identifier type: <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesInt()"><code>entitiesInt</code></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 href="#getOffset()"><code>offset</code></a> from an edge endpoint index to locate it within the returned page. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#TRUE"><code>TRUE</code></a>: Compact integer connectivity for edges; deleted node slots included in node output. </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped. </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>.
                    </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#INCLUDE_WEIGHTS"><code>INCLUDE\_WEIGHTS</code></a>: When true and <code>options entityType</code> is 'edge', the response <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesInt()"><code>entitiesInt</code></a> or <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesString()"><code>entitiesString</code></a>). Empty when the graph has no weights component or when requesting nodes. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#TRUE"><code>TRUE</code></a>: Populate <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> with per-edge weights (edge requests only). </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>: Default: <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> is empty. </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest.Options#FALSE"><code>FALSE</code></a>.
                    </li>
                  </ul>

                  The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>options</code> - The new value for <code>options</code>.</div>
                  <div className="dt">Returns:</div>
                  <div className="dd"><code>this</code> to mimic the builder pattern.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getSchema()">
                <h3>getSchema</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type">org.apache.avro.Schema</span> <span className="element-name">getSchema</span>()</div>
                <div className="block">This method supports the Avro framework and is not intended to be called directly by the user.</div>

                <div className="dl notes">
                  <div className="dt">Specified by:</div>
                  <div className="dd"><code>getSchema</code> in interface <code>org.apache.avro.generic.GenericContainer</code></div>
                  <div className="dt">Returns:</div>
                  <div className="dd">The schema object describing this class.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="get(int)">
                <h3>get</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></span> <span className="element-name">get</span><wbr /><span className="parameters">(int index)</span></div>
                <div className="block">This method supports the Avro framework and is not intended to be called directly by the user.</div>

                <div className="dl notes">
                  <div className="dt">Specified by:</div>
                  <div className="dd"><code>get</code> in interface <code>org.apache.avro.generic.IndexedRecord</code></div>
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>index</code> - the position of the field to get</div>
                  <div className="dt">Returns:</div>
                  <div className="dd">value of the field with the given index.</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" className="external-link">IndexOutOfBoundsException</a></code></div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="put(int,java.lang.Object)">
                <h3>put</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type">void</span> <span className="element-name">put</span><wbr /><span className="parameters">(int index, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a> value)</span></div>
                <div className="block">This method supports the Avro framework and is not intended to be called directly by the user.</div>

                <div className="dl notes">
                  <div className="dt">Specified by:</div>
                  <div className="dd"><code>put</code> in interface <code>org.apache.avro.generic.IndexedRecord</code></div>
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>index</code> - the position of the field to set</div>
                  <div className="dd"><code>value</code> - the value to set</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" className="external-link">IndexOutOfBoundsException</a></code></div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="equals(java.lang.Object)">
                <h3>equals</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type">boolean</span> <span className="element-name">equals</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a> obj)</span></div>

                <div className="dl notes">
                  <div className="dt">Overrides:</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" className="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></code></div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="toString()">
                <h3>toString</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">toString</span>()</div>

                <div className="dl notes">
                  <div className="dt">Overrides:</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" className="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></code></div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="hashCode()">
                <h3>hashCode</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type">int</span> <span className="element-name">hashCode</span>()</div>

                <div className="dl notes">
                  <div className="dt">Overrides:</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" className="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></code></div>
                </div>
              </div>
            </li>
          </ul>
        </div>
      </li>
    </ul>
  </div>
</div>