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

# FilterByTableRequest

> FilterByTableRequest — 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 FilterByTableRequest" className="title">Class FilterByTableRequest</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.FilterByTableRequest</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">FilterByTableRequest</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#filterByTable(com.gpudb.protocol.FilterByTableRequest)"><code>GPUdb.filterByTable</code></a>.
      <p> Filters objects in one table based on objects in another table. The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a <a href="#getViewName()"><code>viewName</code></a> is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.</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/FilterByTableRequest.Options" className="type-name-link" title="class in com.gpudb.protocol">FilterByTableRequest.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/FilterByTableRequest" title="class in com.gpudb.protocol"><code>FilterByTableRequest</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">FilterByTableRequest</a>()</code></div>

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

            <div className="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.util.Map)" className="member-name-link">FilterByTableRequest</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> tableName, <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> viewName, <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> columnName, <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> sourceTableName, <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> sourceTableColumnName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</code></div>

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

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

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

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

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

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

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

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

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name of the column by whose value the data will be filtered from the table designated by <a href="#getTableName()"><code>tableName</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/Map.html" title="class or interface in java.util" className="external-link">Map</a><wbr />\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOptions()" className="member-name-link">getOptions</a>()</code></div>

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

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

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

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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="#getSourceTableColumnName()" className="member-name-link">getSourceTableColumnName</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name of the column in the <a href="#getSourceTableName()"><code>sourceTableName</code></a> whose values will be used as the filter for table <a href="#getTableName()"><code>tableName</code></a>.</div>
                </div>

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

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name of the table whose data will be compared against in the table called <a href="#getTableName()"><code>tableName</code></a>, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</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/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="#getTableName()" className="member-name-link">getTableName</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name of the table whose data will be filtered, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>.</div>
                </div>

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

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>.</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/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setColumnName(java.lang.String)" className="member-name-link">setColumnName</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> columnName)</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name of the column by whose value the data will be filtered from the table designated by <a href="#getTableName()"><code>tableName</code></a>.</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/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</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="/content/api/java/com/gpudb/protocol/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSourceTableColumnName(java.lang.String)" className="member-name-link">setSourceTableColumnName</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> sourceTableColumnName)</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name of the column in the <a href="#getSourceTableName()"><code>sourceTableName</code></a> whose values will be used as the filter for table <a href="#getTableName()"><code>tableName</code></a>.</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/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSourceTableName(java.lang.String)" className="member-name-link">setSourceTableName</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> sourceTableName)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name of the table whose data will be compared against in the table called <a href="#getTableName()"><code>tableName</code></a>, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</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/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTableName(java.lang.String)" className="member-name-link">setTableName</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> tableName)</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name of the table whose data will be filtered, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>.</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/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setViewName(java.lang.String)" className="member-name-link">setViewName</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> viewName)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</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/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>FilterByTableRequest</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">FilterByTableRequest</span>()</div>
                <div className="block">Constructs a FilterByTableRequest object with default parameters.</div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.util.Map)">
                <h3>FilterByTableRequest</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">FilterByTableRequest</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <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> viewName, <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> columnName, <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> sourceTableName, <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> sourceTableColumnName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span></div>
                <div className="block">Constructs a FilterByTableRequest object with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>tableName</code> - Name of the table whose data will be filtered, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table.</div>
                  <div className="dd"><code>viewName</code> - If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. Must not be an already existing table or view. The default value is ''.</div>
                  <div className="dd"><code>columnName</code> - Name of the column by whose value the data will be filtered from the table designated by <code> tableName</code>.</div>
                  <div className="dd"><code>sourceTableName</code> - Name of the table whose data will be compared against in the table called <code>tableName</code>, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table.</div>
                  <div className="dd"><code>sourceTableColumnName</code> - Name of the column in the <code> sourceTableName</code> whose values will be used as the filter for table <code>tableName</code>. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the <code>columnName</code>.</div>

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

                    <ul>
                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#CREATE_TEMP_TABLE"><code>CREATE\_TEMP\_TABLE</code></a>: If <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#TRUE"><code>TRUE</code></a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <code>viewName</code>. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a href="/content/api/java/com/gpudb/protocol/FilterByTableResponse.Info#QUALIFIED_VIEW_NAME"><code>QUALIFIED\_VIEW\_NAME</code></a>. Supported values:

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

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

                      <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#COLLECTION_NAME"><code>COLLECTION\_NAME</code></a>: \[DEPRECATED--please specify the containing schema for the view as part of <code>viewName</code> and use <a href="/content/api/java/com/gpudb/GPUdb#createSchema(com.gpudb.protocol.CreateSchemaRequest)"><code>GPUdb.createSchema</code></a> to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created. </li>

                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#FILTER_MODE"><code>FILTER\_MODE</code></a>: String indicating the filter mode, either <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#IN_TABLE"><code>IN\_TABLE</code></a> or <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NOT_IN_TABLE"><code>NOT\_IN\_TABLE</code></a>. Supported values:

                        <ul>
                          <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#IN_TABLE"><code>IN\_TABLE</code></a> </li>
                          <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NOT_IN_TABLE"><code>NOT\_IN\_TABLE</code></a> </li>
                        </ul>

                        The default value is <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#IN_TABLE"><code>IN\_TABLE</code></a>.
                      </li>

                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#MODE"><code>MODE</code></a>: Mode - should be either <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> or <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NORMAL"><code>NORMAL</code></a>. Supported values:

                        <ul>
                          <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NORMAL"><code>NORMAL</code></a> </li>
                          <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> </li>
                        </ul>

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

                      <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#BUFFER"><code>BUFFER</code></a>: Buffer size, in meters. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is '0'. </li>

                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#BUFFER_METHOD"><code>BUFFER\_METHOD</code></a>: Method used to buffer polygons. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. Supported values:

                        <ul>
                          <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NORMAL"><code>NORMAL</code></a> </li>
                          <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#GEOS"><code>GEOS</code></a>: Use geos 1 edge per corner algorithm. </li>
                        </ul>

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

                      <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#MAX_PARTITION_SIZE"><code>MAX\_PARTITION\_SIZE</code></a>: Maximum number of points in a partition. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is '0'. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#MAX_PARTITION_SCORE"><code>MAX\_PARTITION\_SCORE</code></a>: Maximum number of points \* edges in a partition. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is '8000000'. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#X_COLUMN_NAME"><code>X\_COLUMN\_NAME</code></a>: Name of column containing x value of point being filtered in <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is 'x'. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#Y_COLUMN_NAME"><code>Y\_COLUMN\_NAME</code></a>: Name of column containing y value of point being filtered in <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is 'y'. </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="getTableName()">
                <h3>getTableName</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">getTableName</span>()</div>
                <div className="block">Name of the table whose data will be filtered, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table.</div>

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

            <li>
              <div className="section detail" id="setTableName(java.lang.String)">
                <h3>setTableName</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</a></span> <span className="element-name">setTableName</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName)</span></div>
                <div className="block">Name of the table whose data will be filtered, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>tableName</code> - The new value for <code>tableName</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="getViewName()">
                <h3>getViewName</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">getViewName</span>()</div>
                <div className="block">If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. Must not be an already existing table or view. The default value is ''.</div>

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

            <li>
              <div className="section detail" id="setViewName(java.lang.String)">
                <h3>setViewName</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</a></span> <span className="element-name">setViewName</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> viewName)</span></div>
                <div className="block">If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. Must not be an already existing table or view. The default value is ''.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>viewName</code> - The new value for <code>viewName</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="getColumnName()">
                <h3>getColumnName</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">getColumnName</span>()</div>
                <div className="block">Name of the column by whose value the data will be filtered from the table designated by <a href="#getTableName()"><code>tableName</code></a>.</div>

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

            <li>
              <div className="section detail" id="setColumnName(java.lang.String)">
                <h3>setColumnName</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</a></span> <span className="element-name">setColumnName</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> columnName)</span></div>
                <div className="block">Name of the column by whose value the data will be filtered from the table designated by <a href="#getTableName()"><code>tableName</code></a>.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>columnName</code> - The new value for <code>columnName</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="getSourceTableName()">
                <h3>getSourceTableName</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">getSourceTableName</span>()</div>
                <div className="block">Name of the table whose data will be compared against in the table called <a href="#getTableName()"><code>tableName</code></a>, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table.</div>

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

            <li>
              <div className="section detail" id="setSourceTableName(java.lang.String)">
                <h3>setSourceTableName</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</a></span> <span className="element-name">setSourceTableName</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> sourceTableName)</span></div>
                <div className="block">Name of the table whose data will be compared against in the table called <a href="#getTableName()"><code>tableName</code></a>, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>sourceTableName</code> - The new value for <code>sourceTableName</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="getSourceTableColumnName()">
                <h3>getSourceTableColumnName</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">getSourceTableColumnName</span>()</div>
                <div className="block">Name of the column in the <a href="#getSourceTableName()"><code>sourceTableName</code></a> whose values will be used as the filter for table <a href="#getTableName()"><code>tableName</code></a>. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the <a href="#getColumnName()"><code>columnName</code></a>.</div>

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

            <li>
              <div className="section detail" id="setSourceTableColumnName(java.lang.String)">
                <h3>setSourceTableColumnName</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</a></span> <span className="element-name">setSourceTableColumnName</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> sourceTableColumnName)</span></div>
                <div className="block">Name of the column in the <a href="#getSourceTableName()"><code>sourceTableName</code></a> whose values will be used as the filter for table <a href="#getTableName()"><code>tableName</code></a>. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the <a href="#getColumnName()"><code>columnName</code></a>.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>sourceTableColumnName</code> - The new value for <code> sourceTableColumnName</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/FilterByTableRequest.Options#CREATE_TEMP_TABLE"><code>CREATE\_TEMP\_TABLE</code></a>: If <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#TRUE"><code>TRUE</code></a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a href="#getViewName()"><code>viewName</code></a>. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a href="/content/api/java/com/gpudb/protocol/FilterByTableResponse.Info#QUALIFIED_VIEW_NAME"><code>QUALIFIED\_VIEW\_NAME</code></a>. Supported values:

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

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

                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#COLLECTION_NAME"><code>COLLECTION\_NAME</code></a>: \[DEPRECATED--please specify the containing schema for the view as part of <a href="#getViewName()"><code>viewName</code></a> and use <a href="/content/api/java/com/gpudb/GPUdb#createSchema(com.gpudb.protocol.CreateSchemaRequest)"><code>GPUdb.createSchema</code></a> to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created. </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#FILTER_MODE"><code>FILTER\_MODE</code></a>: String indicating the filter mode, either <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#IN_TABLE"><code>IN\_TABLE</code></a> or <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NOT_IN_TABLE"><code>NOT\_IN\_TABLE</code></a>. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#IN_TABLE"><code>IN\_TABLE</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NOT_IN_TABLE"><code>NOT\_IN\_TABLE</code></a> </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#IN_TABLE"><code>IN\_TABLE</code></a>.
                    </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#MODE"><code>MODE</code></a>: Mode - should be either <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> or <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NORMAL"><code>NORMAL</code></a>. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NORMAL"><code>NORMAL</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> </li>
                      </ul>

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

                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#BUFFER"><code>BUFFER</code></a>: Buffer size, in meters. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is '0'. </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#BUFFER_METHOD"><code>BUFFER\_METHOD</code></a>: Method used to buffer polygons. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NORMAL"><code>NORMAL</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#GEOS"><code>GEOS</code></a>: Use geos 1 edge per corner algorithm. </li>
                      </ul>

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

                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#MAX_PARTITION_SIZE"><code>MAX\_PARTITION\_SIZE</code></a>: Maximum number of points in a partition. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is '0'. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#MAX_PARTITION_SCORE"><code>MAX\_PARTITION\_SCORE</code></a>: Maximum number of points \* edges in a partition. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is '8000000'. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#X_COLUMN_NAME"><code>X\_COLUMN\_NAME</code></a>: Name of column containing x value of point being filtered in <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is 'x'. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#Y_COLUMN_NAME"><code>Y\_COLUMN\_NAME</code></a>: Name of column containing y value of point being filtered in <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is 'y'. </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/FilterByTableRequest" title="class in com.gpudb.protocol">FilterByTableRequest</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/FilterByTableRequest.Options#CREATE_TEMP_TABLE"><code>CREATE\_TEMP\_TABLE</code></a>: If <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#TRUE"><code>TRUE</code></a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a href="#getViewName()"><code>viewName</code></a>. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a href="/content/api/java/com/gpudb/protocol/FilterByTableResponse.Info#QUALIFIED_VIEW_NAME"><code>QUALIFIED\_VIEW\_NAME</code></a>. Supported values:

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

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

                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#COLLECTION_NAME"><code>COLLECTION\_NAME</code></a>: \[DEPRECATED--please specify the containing schema for the view as part of <a href="#getViewName()"><code>viewName</code></a> and use <a href="/content/api/java/com/gpudb/GPUdb#createSchema(com.gpudb.protocol.CreateSchemaRequest)"><code>GPUdb.createSchema</code></a> to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created. </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#FILTER_MODE"><code>FILTER\_MODE</code></a>: String indicating the filter mode, either <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#IN_TABLE"><code>IN\_TABLE</code></a> or <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NOT_IN_TABLE"><code>NOT\_IN\_TABLE</code></a>. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#IN_TABLE"><code>IN\_TABLE</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NOT_IN_TABLE"><code>NOT\_IN\_TABLE</code></a> </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#IN_TABLE"><code>IN\_TABLE</code></a>.
                    </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#MODE"><code>MODE</code></a>: Mode - should be either <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> or <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NORMAL"><code>NORMAL</code></a>. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NORMAL"><code>NORMAL</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> </li>
                      </ul>

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

                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#BUFFER"><code>BUFFER</code></a>: Buffer size, in meters. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is '0'. </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#BUFFER_METHOD"><code>BUFFER\_METHOD</code></a>: Method used to buffer polygons. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#NORMAL"><code>NORMAL</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#GEOS"><code>GEOS</code></a>: Use geos 1 edge per corner algorithm. </li>
                      </ul>

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

                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#MAX_PARTITION_SIZE"><code>MAX\_PARTITION\_SIZE</code></a>: Maximum number of points in a partition. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is '0'. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#MAX_PARTITION_SCORE"><code>MAX\_PARTITION\_SCORE</code></a>: Maximum number of points \* edges in a partition. Only relevant for <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is '8000000'. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#X_COLUMN_NAME"><code>X\_COLUMN\_NAME</code></a>: Name of column containing x value of point being filtered in <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is 'x'. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#Y_COLUMN_NAME"><code>Y\_COLUMN\_NAME</code></a>: Name of column containing y value of point being filtered in <a href="/content/api/java/com/gpudb/protocol/FilterByTableRequest.Options#SPATIAL"><code>SPATIAL</code></a> mode. The default value is 'y'. </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>
