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

# AdminRemoveRanksRequest

> AdminRemoveRanksRequest — 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 AdminRemoveRanksRequest" className="title">Class AdminRemoveRanksRequest</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.AdminRemoveRanksRequest</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">AdminRemoveRanksRequest</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#adminRemoveRanks(com.gpudb.protocol.AdminRemoveRanksRequest)"><code>GPUdb.adminRemoveRanks</code></a>.
      <p> Remove one or more ranks from an existing Kinetica cluster. All data will be rebalanced to other ranks before the rank(s) is removed unless the <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#REBALANCE_SHARDED_DATA"><code>REBALANCE\_SHARDED\_DATA</code></a> or <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#REBALANCE_UNSHARDED_DATA"><code>REBALANCE\_UNSHARDED\_DATA</code></a> parameters are set to <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#FALSE"><code>FALSE</code></a> in the <a href="#getOptions()"><code>options</code></a>, in which case the corresponding <a href="/content/concepts/tables/#sharding" target="_top">sharded data</a> and/or unsharded data (a.k.a. <a href="/content/concepts/tables/#random-sharding" target="_top">randomly-sharded</a>) will be deleted. </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> This endpoint's processing time depends on the amount of data in the system, thus 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/AdminRemoveRanksRequest.Options" className="type-name-link" title="class in com.gpudb.protocol">AdminRemoveRanksRequest.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/AdminRemoveRanksRequest" title="class in com.gpudb.protocol"><code>AdminRemoveRanksRequest</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">AdminRemoveRanksRequest</a>()</code></div>

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

            <div className="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.List,java.util.Map)" className="member-name-link">AdminRemoveRanksRequest</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>> ranks, <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 AdminRemoveRanksRequest 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/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><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="#getRanks()" className="member-name-link">getRanks</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Each array value designates one or more ranks to remove from the cluster.</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/AdminRemoveRanksRequest" title="class in com.gpudb.protocol">AdminRemoveRanksRequest</a></code></div>
                <div className="col-second even-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 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><a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest" title="class in com.gpudb.protocol">AdminRemoveRanksRequest</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRanks(java.util.List)" className="member-name-link">setRanks</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>> ranks)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Each array value designates one or more ranks to remove from the cluster.</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>AdminRemoveRanksRequest</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">AdminRemoveRanksRequest</span>()</div>
                <div className="block">Constructs an AdminRemoveRanksRequest object with default parameters.</div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(java.util.List,java.util.Map)">
                <h3>AdminRemoveRanksRequest</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">AdminRemoveRanksRequest</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>> ranks, <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 AdminRemoveRanksRequest object with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>ranks</code> - Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using <a href="/content/api/java/com/gpudb/GPUdb#adminSwitchover(com.gpudb.protocol.AdminSwitchoverRequest)"><code>GPUdb.adminSwitchover</code></a>). At least one worker rank must be left in the cluster after the operation.</div>

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

                    <ul>
                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#REBALANCE_SHARDED_DATA"><code>REBALANCE\_SHARDED\_DATA</code></a>: If <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#TRUE"><code>TRUE</code></a>, <a href="/content/concepts/tables/#sharding" target="_top">sharded data</a> will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:

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

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

                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#REBALANCE_UNSHARDED_DATA"><code>REBALANCE\_UNSHARDED\_DATA</code></a>: If <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#TRUE"><code>TRUE</code></a>, unsharded data (a.k.a. <a href="/content/concepts/tables/#random-sharding" target="_top">randomly-sharded</a>) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:

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

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

                      <li><a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a>: Influences how much data is moved at a time during rebalance. A higher <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a> will complete the rebalance faster. A lower <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a> will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'. </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="getRanks()">
                <h3>getRanks</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">getRanks</span>()</div>
                <div className="block">Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using <a href="/content/api/java/com/gpudb/GPUdb#adminSwitchover(com.gpudb.protocol.AdminSwitchoverRequest)"><code>GPUdb.adminSwitchover</code></a>). At least one worker rank must be left in the cluster after the operation.</div>

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

            <li>
              <div className="section detail" id="setRanks(java.util.List)">
                <h3>setRanks</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest" title="class in com.gpudb.protocol">AdminRemoveRanksRequest</a></span> <span className="element-name">setRanks</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>> ranks)</span></div>
                <div className="block">Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using <a href="/content/api/java/com/gpudb/GPUdb#adminSwitchover(com.gpudb.protocol.AdminSwitchoverRequest)"><code>GPUdb.adminSwitchover</code></a>). At least one worker rank must be left in the cluster after the operation.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>ranks</code> - The new value for <code>ranks</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/AdminRemoveRanksRequest.Options#REBALANCE_SHARDED_DATA"><code>REBALANCE\_SHARDED\_DATA</code></a>: If <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#TRUE"><code>TRUE</code></a>, <a href="/content/concepts/tables/#sharding" target="_top">sharded data</a> will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:

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

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

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#REBALANCE_UNSHARDED_DATA"><code>REBALANCE\_UNSHARDED\_DATA</code></a>: If <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#TRUE"><code>TRUE</code></a>, unsharded data (a.k.a. <a href="/content/concepts/tables/#random-sharding" target="_top">randomly-sharded</a>) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:

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

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

                    <li><a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a>: Influences how much data is moved at a time during rebalance. A higher <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a> will complete the rebalance faster. A lower <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a> will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'. </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/AdminRemoveRanksRequest" title="class in com.gpudb.protocol">AdminRemoveRanksRequest</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/AdminRemoveRanksRequest.Options#REBALANCE_SHARDED_DATA"><code>REBALANCE\_SHARDED\_DATA</code></a>: If <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#TRUE"><code>TRUE</code></a>, <a href="/content/concepts/tables/#sharding" target="_top">sharded data</a> will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:

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

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

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#REBALANCE_UNSHARDED_DATA"><code>REBALANCE\_UNSHARDED\_DATA</code></a>: If <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#TRUE"><code>TRUE</code></a>, unsharded data (a.k.a. <a href="/content/concepts/tables/#random-sharding" target="_top">randomly-sharded</a>) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:

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

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

                    <li><a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a>: Influences how much data is moved at a time during rebalance. A higher <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a> will complete the rebalance faster. A lower <a href="/content/api/java/com/gpudb/protocol/AdminRemoveRanksRequest.Options#AGGRESSIVENESS"><code>AGGRESSIVENESS</code></a> will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'. </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>