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

> GetGraphEntitiesRequest.Options — 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.Options" className="title">Class GetGraphEntitiesRequest.Options</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.Options</div>
  </div>

  <div className="section class-description" id="class-description">
    <div className="dl notes">
      <div className="dt">Enclosing class:</div>
      <div className="dd"><code><a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest" title="class in com.gpudb.protocol">GetGraphEntitiesRequest</a></code></div>
    </div>

    <hr />

    <div className="type-signature"><span className="modifiers">public static final class </span><span className="element-name type-name-label">GetGraphEntitiesRequest.Options</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></span></div>

    <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="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest#getOptions()"><code>options</code></a>.
      <p> Optional parameters.</p>
    </div>
  </div>

  <div className="section summary">
    <ul className="summary-list">
      <li>
        <div className="section field-summary" id="field-summary">
          <h2>Field Summary</h2>
          <div className="caption"><span>Fields</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">Field</div>
            <div className="table-header col-last">Description</div>
            <div className="col-first even-row-color"><code>static final <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"><code><a href="#CONCISE_EDGE_CONNECTIVITY" className="member-name-link">CONCISE\_EDGE\_CONNECTIVITY</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">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).</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <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"><code><a href="#EDGE" className="member-name-link">EDGE</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Retrieve edge entities (default).</div>
            </div>

            <div className="col-first even-row-color"><code>static final <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"><code><a href="#ENTITY_TYPE" className="member-name-link">ENTITY\_TYPE</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">The type of entity to retrieve.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <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"><code><a href="#FALSE" className="member-name-link">FALSE</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Default: <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> is empty.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <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"><code><a href="#INCLUDE_WEIGHTS" className="member-name-link">INCLUDE\_WEIGHTS</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">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>).</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <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"><code><a href="#NODE" className="member-name-link">NODE</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Retrieve node entities.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <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"><code><a href="#SERVER_ID" className="member-name-link">SERVER\_ID</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Indicates which graph server to send the request to.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <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"><code><a href="#TRUE" className="member-name-link">TRUE</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Populate <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> with per-edge weights (edge requests only).</div>
            </div>
          </div>
        </div>
      </li>

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

          <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#equals(java.lang.Object)" title="class or interface in java.lang" className="external-link">equals</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#hashCode()" title="class or interface in java.lang" className="external-link">hashCode</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#toString()" title="class or interface in java.lang" className="external-link">toString</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 field-details" id="field-detail">
          <h2>Field Details</h2>

          <ul className="member-list">
            <li>
              <div className="section detail" id="ENTITY_TYPE">
                <h3>ENTITY\_TYPE</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">ENTITY\_TYPE</span></div>

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

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

                  The default value is <a href="#EDGE"><code>EDGE</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetGraphEntitiesRequest.Options.ENTITY_TYPE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="EDGE">
                <h3>EDGE</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">EDGE</span></div>
                <div className="block">Retrieve edge entities (default).</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetGraphEntitiesRequest.Options.EDGE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="NODE">
                <h3>NODE</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">NODE</span></div>
                <div className="block">Retrieve node entities.</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetGraphEntitiesRequest.Options.NODE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="SERVER_ID">
                <h3>SERVER\_ID</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">SERVER\_ID</span></div>
                <div className="block">Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is '0'.</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetGraphEntitiesRequest.Options.SERVER_ID">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="CONCISE_EDGE_CONNECTIVITY">
                <h3>CONCISE\_EDGE\_CONNECTIVITY</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">CONCISE\_EDGE\_CONNECTIVITY</span></div>

                <div className="block">
                  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="/content/api/java/com/gpudb/protocol/GetGraphEntitiesRequest#getOffset()"><code>offset</code></a> from an edge endpoint index to locate it within the returned page. Supported values:

                  <ul>
                    <li><a href="#TRUE"><code>TRUE</code></a>: Compact integer connectivity for edges; deleted node slots included in node output. </li>
                    <li><a href="#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="#FALSE"><code>FALSE</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetGraphEntitiesRequest.Options.CONCISE_EDGE_CONNECTIVITY">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="TRUE">
                <h3>TRUE</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">TRUE</span></div>
                <div className="block">Populate <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> with per-edge weights (edge requests only).</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetGraphEntitiesRequest.Options.TRUE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="FALSE">
                <h3>FALSE</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">FALSE</span></div>
                <div className="block">Default: <a href="/content/api/java/com/gpudb/protocol/GetGraphEntitiesResponse#getEntitiesWeight()"><code>entitiesWeight</code></a> is empty.</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetGraphEntitiesRequest.Options.FALSE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="INCLUDE_WEIGHTS">
                <h3>INCLUDE\_WEIGHTS</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">INCLUDE\_WEIGHTS</span></div>

                <div className="block">
                  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="#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="#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="#FALSE"><code>FALSE</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetGraphEntitiesRequest.Options.INCLUDE_WEIGHTS">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>
          </ul>
        </div>
      </li>
    </ul>
  </div>
</div>