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

# AdminAddRanksRequest

> AdminAddRanksRequest — 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 AdminAddRanksRequest" className="title">Class AdminAddRanksRequest</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.AdminAddRanksRequest</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">AdminAddRanksRequest</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#adminAddRanks(com.gpudb.protocol.AdminAddRanksRequest)"><code>GPUdb.adminAddRanks</code></a>.
      <p> Add one or more ranks to an existing Kinetica cluster. The new ranks will not contain any data initially (other than replicated tables) and will not be assigned any shards. To rebalance data and shards across the cluster, use <a href="/content/api/java/com/gpudb/GPUdb#adminRebalance(com.gpudb.protocol.AdminRebalanceRequest)"><code>GPUdb.adminRebalance</code></a>. </p>
      <p> The database must be offline for this operation, see <a href="/content/api/java/com/gpudb/GPUdb#adminOffline(com.gpudb.protocol.AdminOfflineRequest)"><code>GPUdb.adminOffline</code></a> </p>
      <p> For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters: </p>
      <p> \* <a href="#getHosts()"><code>hosts</code></a> would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67) </p>
      <p> \* <a href="#getConfigParams()"><code>configParams</code></a> would be an array of maps, with each map corresponding to the ranks being added in <a href="#getHosts()"><code>hosts</code></a>. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. '{"{"}"rank.gpu":"1"{"}"}' </p>
      <p> This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via <a href="/content/api/java/com/gpudb/GPUdb#createJob(com.gpudb.protocol.CreateJobRequest)"><code>GPUdb.createJob</code></a>.</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/AdminAddRanksRequest.Options" className="type-name-link" title="class in com.gpudb.protocol">AdminAddRanksRequest.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/AdminAddRanksRequest" title="class in com.gpudb.protocol"><code>AdminAddRanksRequest</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">AdminAddRanksRequest</a>()</code></div>

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

            <div className="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.List,java.util.List,java.util.Map)" className="member-name-link">AdminAddRanksRequest</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</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>> hosts, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<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>>> configParams, <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 an AdminAddRanksRequest 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/util/List.html" title="class or interface in java.util" className="external-link">List</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>>></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfigParams()" className="member-name-link">getConfigParams</a>()</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Array of maps containing configuration parameters to apply to the new ranks found in <a href="#getHosts()"><code>hosts</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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</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="#getHosts()" className="member-name-link">getHosts</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster.</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/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 odd-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 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>org.apache.avro.Schema</code></div>
                <div className="col-second even-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 even-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
                <div className="col-second odd-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
                <div className="col-second even-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 even-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest" title="class in com.gpudb.protocol">AdminAddRanksRequest</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConfigParams(java.util.List)" className="member-name-link">setConfigParams</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<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>>> configParams)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Array of maps containing configuration parameters to apply to the new ranks found in <a href="#getHosts()"><code>hosts</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/AdminAddRanksRequest" title="class in com.gpudb.protocol">AdminAddRanksRequest</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHosts(java.util.List)" className="member-name-link">setHosts</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</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>> hosts)</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster.</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/AdminAddRanksRequest" title="class in com.gpudb.protocol">AdminAddRanksRequest</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>AdminAddRanksRequest</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">AdminAddRanksRequest</span>()</div>
                <div className="block">Constructs an AdminAddRanksRequest object with default parameters.</div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(java.util.List,java.util.List,java.util.Map)">
                <h3>AdminAddRanksRequest</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">AdminAddRanksRequest</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</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>> hosts, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<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>>> configParams, <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 an AdminAddRanksRequest object with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>hosts</code> - Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use <a href="/content/api/java/com/gpudb/GPUdb#adminAddHost(com.gpudb.protocol.AdminAddHostRequest)"><code>GPUdb.adminAddHost</code></a>. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, <code>hosts</code> could look like '\["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the <code> configParams</code>.</div>
                  <div className="dd"><code>configParams</code> - Array of maps containing configuration parameters to apply to the new ranks found in <code>hosts</code>. For example, '{"{"}"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"{"}"}'. Currently, the available parameters are rank-specific parameters in the <a href="/content/config/#config-main-network" target="_top">Network</a>, <a href="/content/config/#config-main-hardware" target="_top">Hardware</a>, <a href="/content/config/#config-main-text-search" target="_top">Text Search</a>, and <a href="/content/config/#config-main-ram-tier" target="_top">RAM Tiered Storage</a> sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by <code>hosts</code> instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in <code>configParams</code> as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the <code>hosts</code>. This array must either be completely empty or have the same number of elements as the <code>hosts</code>. An empty <code>configParams</code> array will result in the new ranks being set with default parameters.</div>

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

                    <ul>
                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: If <a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.Options#TRUE"><code>TRUE</code></a>, only validation checks will be performed. No ranks are added. Supported values:

                        <ul>
                          <li><a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.Options#TRUE"><code>TRUE</code></a> </li>
                          <li><a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.Options#FALSE"><code>FALSE</code></a> </li>
                        </ul>

                        The default value is <a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.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="getHosts()">
                <h3>getHosts</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/List.html" title="class or interface in java.util" className="external-link">List</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>></span> <span className="element-name">getHosts</span>()</div>
                <div className="block">Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use <a href="/content/api/java/com/gpudb/GPUdb#adminAddHost(com.gpudb.protocol.AdminAddHostRequest)"><code>GPUdb.adminAddHost</code></a>. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, <a href="#getHosts()"><code>hosts</code></a> could look like '\["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the <a href="#getConfigParams()"><code>configParams</code></a>.</div>

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

            <li>
              <div className="section detail" id="setHosts(java.util.List)">
                <h3>setHosts</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest" title="class in com.gpudb.protocol">AdminAddRanksRequest</a></span> <span className="element-name">setHosts</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</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>> hosts)</span></div>
                <div className="block">Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use <a href="/content/api/java/com/gpudb/GPUdb#adminAddHost(com.gpudb.protocol.AdminAddHostRequest)"><code>GPUdb.adminAddHost</code></a>. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, <a href="#getHosts()"><code>hosts</code></a> could look like '\["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the <a href="#getConfigParams()"><code>configParams</code></a>.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>hosts</code> - The new value for <code>hosts</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="getConfigParams()">
                <h3>getConfigParams</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/List.html" title="class or interface in java.util" className="external-link">List</a>\<<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">getConfigParams</span>()</div>
                <div className="block">Array of maps containing configuration parameters to apply to the new ranks found in <a href="#getHosts()"><code>hosts</code></a>. For example, '{"{"}"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"{"}"}'. Currently, the available parameters are rank-specific parameters in the <a href="/content/config/#config-main-network" target="_top">Network</a>, <a href="/content/config/#config-main-hardware" target="_top">Hardware</a>, <a href="/content/config/#config-main-text-search" target="_top">Text Search</a>, and <a href="/content/config/#config-main-ram-tier" target="_top">RAM Tiered Storage</a> sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by <a href="#getHosts()"><code>hosts</code></a> instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in <a href="#getConfigParams()"><code>configParams</code></a> as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the <a href="#getHosts()"><code>hosts</code></a>. This array must either be completely empty or have the same number of elements as the <a href="#getHosts()"><code>hosts</code></a>. An empty <a href="#getConfigParams()"><code>configParams</code></a> array will result in the new ranks being set with default parameters.</div>

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

            <li>
              <div className="section detail" id="setConfigParams(java.util.List)">
                <h3>setConfigParams</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest" title="class in com.gpudb.protocol">AdminAddRanksRequest</a></span> <span className="element-name">setConfigParams</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<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>>> configParams)</span></div>
                <div className="block">Array of maps containing configuration parameters to apply to the new ranks found in <a href="#getHosts()"><code>hosts</code></a>. For example, '{"{"}"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"{"}"}'. Currently, the available parameters are rank-specific parameters in the <a href="/content/config/#config-main-network" target="_top">Network</a>, <a href="/content/config/#config-main-hardware" target="_top">Hardware</a>, <a href="/content/config/#config-main-text-search" target="_top">Text Search</a>, and <a href="/content/config/#config-main-ram-tier" target="_top">RAM Tiered Storage</a> sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by <a href="#getHosts()"><code>hosts</code></a> instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in <a href="#getConfigParams()"><code>configParams</code></a> as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the <a href="#getHosts()"><code>hosts</code></a>. This array must either be completely empty or have the same number of elements as the <a href="#getHosts()"><code>hosts</code></a>. An empty <a href="#getConfigParams()"><code>configParams</code></a> array will result in the new ranks being set with default parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>configParams</code> - The new value for <code>configParams</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/AdminAddRanksRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: If <a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.Options#TRUE"><code>TRUE</code></a>, only validation checks will be performed. No ranks are added. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.Options#TRUE"><code>TRUE</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.Options#FALSE"><code>FALSE</code></a> </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.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/AdminAddRanksRequest" title="class in com.gpudb.protocol">AdminAddRanksRequest</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/AdminAddRanksRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: If <a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.Options#TRUE"><code>TRUE</code></a>, only validation checks will be performed. No ranks are added. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.Options#TRUE"><code>TRUE</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.Options#FALSE"><code>FALSE</code></a> </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/AdminAddRanksRequest.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>