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

# BulkInserter.FlushOptions

> BulkInserter.FlushOptions — 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/package-summary">com.gpudb</a></div>
    <h1 title="Class BulkInserter.FlushOptions" className="title">Class BulkInserter.FlushOptions</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.BulkInserter.FlushOptions</div>
  </div>

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

    <hr />

    <div className="type-signature"><span className="modifiers">public static final class </span><span className="element-name type-name-label">BulkInserter.FlushOptions</span> <span className="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></span></div>
    <div className="block">This class facilitates customizing the behavior of automatic flush in <a href="/content/api/java/com/gpudb/BulkInserter" title="class in com.gpudb"><code>BulkInserter</code></a> The default value of the 'flushInterval' is set to a negative value to indicate that the automatic flush feature is not needed. If the default values are passed in for the <a href="/content/api/java/com/gpudb/BulkInserter.FlushOptions" title="class in com.gpudb"><code>BulkInserter.FlushOptions</code></a> instance to the constructors it is mandatory to call the method <a href="/content/api/java/com/gpudb/BulkInserter#flush()"><code>BulkInserter.flush()</code></a> or <a href="/content/api/java/com/gpudb/BulkInserter#close()"><code>BulkInserter.close()</code></a> so that the records are actually saved to the table.</div>

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

      <div className="dd">
        <ul className="tag-list">
          <li><a href="/content/api/java/com/gpudb/BulkInserter#flush()"><code>BulkInserter.flush()</code></a></li>
        </ul>
      </div>
    </div>
  </div>

  <div className="section summary">
    <ul className="summary-list">
      <li>
        <div className="section field-summary" id="field-summary">
          <h2>Field Summary</h2>
          <div className="caption"><span>Fields</span></div>

          <div className="summary-table three-column-summary">
            <div className="table-header col-first">Modifier and Type</div>
            <div className="table-header col-second">Field</div>
            <div className="table-header col-last">Description</div>
            <div className="col-first even-row-color"><code>static final boolean</code></div>
            <div className="col-second even-row-color"><code><a href="#FLUSH_WHEN_FULL" className="member-name-link">FLUSH\_WHEN\_FULL</a></code></div>
            <div className="col-last even-row-color"> </div>
            <div className="col-first odd-row-color"><code>static final int</code></div>
            <div className="col-second odd-row-color"><code><a href="#NO_PERIODIC_FLUSH" className="member-name-link">NO\_PERIODIC\_FLUSH</a></code></div>
            <div className="col-last odd-row-color"> </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">FlushOptions</a>()</code></div>

            <div className="col-last even-row-color">
              <div className="block">Default constructor</div>
            </div>

            <div className="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(boolean,int)" className="member-name-link">FlushOptions</a><wbr />(boolean flushWhenFull, int flushInterval)</code></div>

            <div className="col-last odd-row-color">
              <div className="block">Constructor with all members</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-tab1 method-summary-table-tab4"><code>static <a href="/content/api/java/com/gpudb/BulkInserter.FlushOptions" title="class in com.gpudb">BulkInserter.FlushOptions</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#defaultOptions()" className="member-name-link">defaultOptions</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 returns an instance of <a href="/content/api/java/com/gpudb/BulkInserter.FlushOptions" title="class in com.gpudb"><code>BulkInserter.FlushOptions</code></a> with default values.</div>
                </div>

                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
                <div className="col-second odd-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> o)</code></div>
                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFlushInterval()" className="member-name-link">getFlushInterval</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>int</code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" className="member-name-link">hashCode</a>()</code></div>
                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFlushWhenFull()" className="member-name-link">isFlushWhenFull</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="#setFlushInterval(int)" className="member-name-link">setFlushInterval</a><wbr />(int flushInterval)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Sets the flush interval</div>
                </div>

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

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Sets the flag to set whether to flush when queues are full or not</div>
                </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#toString()" title="class or interface in java.lang" className="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" className="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" className="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" className="external-link">wait</a></code>
          </div>
        </div>
      </li>
    </ul>
  </div>

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

          <ul className="member-list">
            <li>
              <div className="section detail" id="NO_PERIODIC_FLUSH">
                <h3>NO\_PERIODIC\_FLUSH</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type">int</span> <span className="element-name">NO\_PERIODIC\_FLUSH</span></div>

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

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.BulkInserter.FlushOptions.NO_PERIODIC_FLUSH">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="FLUSH_WHEN_FULL">
                <h3>FLUSH\_WHEN\_FULL</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type">boolean</span> <span className="element-name">FLUSH\_WHEN\_FULL</span></div>

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

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.BulkInserter.FlushOptions.FLUSH_WHEN_FULL">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>
          </ul>
        </div>
      </li>

      <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>FlushOptions</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">FlushOptions</span>()</div>
                <div className="block">Default constructor</div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(boolean,int)">
                <h3>FlushOptions</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">FlushOptions</span><wbr /><span className="parameters">(boolean flushWhenFull, int flushInterval)</span></div>
                <div className="block">Constructor with all members</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>flushWhenFull</code> - - boolean value indicating whether to flush only full queues</div>
                  <div className="dd"><code>flushInterval</code> - - the time interval in seconds to execute flush</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="defaultOptions()">
                <h3>defaultOptions</h3>
                <div className="member-signature"><span className="modifiers">public static</span> <span className="return-type"><a href="/content/api/java/com/gpudb/BulkInserter.FlushOptions" title="class in com.gpudb">BulkInserter.FlushOptions</a></span> <span className="element-name">defaultOptions</span>()</div>
                <div className="block">This method returns an instance of <a href="/content/api/java/com/gpudb/BulkInserter.FlushOptions" title="class in com.gpudb"><code>BulkInserter.FlushOptions</code></a> with default values.</div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">- a new instance of <a href="/content/api/java/com/gpudb/BulkInserter.FlushOptions" title="class in com.gpudb"><code>BulkInserter.FlushOptions</code></a> class</div>
                </div>
              </div>
            </li>

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

            <li>
              <div className="section detail" id="setFlushWhenFull(boolean)">
                <h3>setFlushWhenFull</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type">void</span> <span className="element-name">setFlushWhenFull</span><wbr /><span className="parameters">(boolean flushWhenFull)</span></div>
                <div className="block">Sets the flag to set whether to flush when queues are full or not</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>flushWhenFull</code> - - boolean value to indicate whether to flush only full queues</div>
                </div>
              </div>
            </li>

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

            <li>
              <div className="section detail" id="setFlushInterval(int)">
                <h3>setFlushInterval</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type">void</span> <span className="element-name">setFlushInterval</span><wbr /><span className="parameters">(int flushInterval)</span></div>
                <div className="block">Sets the flush interval</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>flushInterval</code> - - time in seconds</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> o)</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="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>