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

# ShowBackupRequest.Options

> ShowBackupRequest.Options — Kinetica Java API

<div className="kinetica-javadoc">
  <div className="header">
    <div className="sub-title"><span className="package-label-in-type">Package</span> <a href="/content/api/java/com/gpudb/protocol/package-summary">com.gpudb.protocol</a></div>
    <h1 title="Class ShowBackupRequest.Options" className="title">Class ShowBackupRequest.Options</h1>
  </div>

  <div className="inheritance" title="Inheritance Tree">
    <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">java.lang.Object</a>
    <div className="inheritance">com.gpudb.protocol.ShowBackupRequest.Options</div>
  </div>

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

    <hr />

    <div className="type-signature"><span className="modifiers">public static final class </span><span className="element-name type-name-label">ShowBackupRequest.Options</span> <span className="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></span></div>

    <div className="block">
      A set of string constants for the <a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest" title="class in com.gpudb.protocol"><code>ShowBackupRequest</code></a> parameter <a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest#getOptions()"><code>options</code></a>.
      <p> Optional parameters.</p>
    </div>
  </div>

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

          <div className="summary-table three-column-summary">
            <div className="table-header col-first">Modifier and Type</div>
            <div className="table-header col-second">Field</div>
            <div className="table-header col-last">Description</div>
            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#ALL" className="member-name-link">ALL</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Show all backup types.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#BACKUP_ID" className="member-name-link">BACKUP\_ID</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">ID of the snapshot to show.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#BACKUP_TYPE" className="member-name-link">BACKUP\_TYPE</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Show backups by type.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#DIFFERENTIAL" className="member-name-link">DIFFERENTIAL</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Show differential backups only.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#FALSE" className="member-name-link">FALSE</a></code></div>
            <div className="col-last even-row-color"> </div>
            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#FULL" className="member-name-link">FULL</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Show full backups only.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#INCREMENTAL" className="member-name-link">INCREMENTAL</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Show incremental backups only.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#NO_ERROR_IF_NOT_EXISTS" className="member-name-link">NO\_ERROR\_IF\_NOT\_EXISTS</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Whether or not to suppress the error if the specified backup does not exist.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#NONE" className="member-name-link">NONE</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Don't show snapshot contents.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#OBJECT_FILES" className="member-name-link">OBJECT\_FILES</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Show backed-up object names, and for tables, sizing detail and associated files.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#OBJECT_NAMES" className="member-name-link">OBJECT\_NAMES</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Show backed-up object names, and for tables, sizing detail.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second odd-row-color"><code><a href="#SHOW_CONTENTS" className="member-name-link">SHOW\_CONTENTS</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Show the contents of the backed-up snapshots.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
            <div className="col-second even-row-color"><code><a href="#TRUE" className="member-name-link">TRUE</a></code></div>
            <div className="col-last even-row-color"> </div>
          </div>
        </div>
      </li>

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

          <div className="inherited-list">
            <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></h3>
            <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" className="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" className="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" className="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" className="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" className="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" className="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" className="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" className="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" className="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" className="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" className="external-link">wait</a></code>
          </div>
        </div>
      </li>
    </ul>
  </div>

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

          <ul className="member-list">
            <li>
              <div className="section detail" id="BACKUP_ID">
                <h3>BACKUP\_ID</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">BACKUP\_ID</span></div>
                <div className="block">ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ''.</div>

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

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

            <li>
              <div className="section detail" id="BACKUP_TYPE">
                <h3>BACKUP\_TYPE</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">BACKUP\_TYPE</span></div>

                <div className="block">
                  Show backups by type. This option is ignored if <a href="#BACKUP_ID"><code>BACKUP\_ID</code></a> is non-empty. Supported values:

                  <ul>
                    <li><a href="#ALL"><code>ALL</code></a>: Show all backup types. </li>
                    <li><a href="#FULL"><code>FULL</code></a>: Show full backups only. </li>
                    <li><a href="#INCREMENTAL"><code>INCREMENTAL</code></a>: Show incremental backups only. </li>
                    <li><a href="#DIFFERENTIAL"><code>DIFFERENTIAL</code></a>: Show differential backups only. </li>
                  </ul>

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

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

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

            <li>
              <div className="section detail" id="ALL">
                <h3>ALL</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">ALL</span></div>
                <div className="block">Show all backup types.</div>

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

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

            <li>
              <div className="section detail" id="FULL">
                <h3>FULL</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">FULL</span></div>
                <div className="block">Show full backups only.</div>

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

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

            <li>
              <div className="section detail" id="INCREMENTAL">
                <h3>INCREMENTAL</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">INCREMENTAL</span></div>
                <div className="block">Show incremental backups only.</div>

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

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

            <li>
              <div className="section detail" id="DIFFERENTIAL">
                <h3>DIFFERENTIAL</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">DIFFERENTIAL</span></div>
                <div className="block">Show differential backups only.</div>

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

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

            <li>
              <div className="section detail" id="SHOW_CONTENTS">
                <h3>SHOW\_CONTENTS</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">SHOW\_CONTENTS</span></div>

                <div className="block">
                  Show the contents of the backed-up snapshots. Supported values:

                  <ul>
                    <li><a href="#NONE"><code>NONE</code></a>: Don't show snapshot contents. </li>
                    <li><a href="#OBJECT_NAMES"><code>OBJECT\_NAMES</code></a>: Show backed-up object names, and for tables, sizing detail. </li>
                    <li><a href="#OBJECT_FILES"><code>OBJECT\_FILES</code></a>: Show backed-up object names, and for tables, sizing detail and associated files. </li>
                  </ul>

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

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

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

            <li>
              <div className="section detail" id="NONE">
                <h3>NONE</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">NONE</span></div>
                <div className="block">Don't show snapshot contents.</div>

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

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

            <li>
              <div className="section detail" id="OBJECT_NAMES">
                <h3>OBJECT\_NAMES</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">OBJECT\_NAMES</span></div>
                <div className="block">Show backed-up object names, and for tables, sizing detail.</div>

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

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

            <li>
              <div className="section detail" id="OBJECT_FILES">
                <h3>OBJECT\_FILES</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">OBJECT\_FILES</span></div>
                <div className="block">Show backed-up object names, and for tables, sizing detail and associated files.</div>

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

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

            <li>
              <div className="section detail" id="NO_ERROR_IF_NOT_EXISTS">
                <h3>NO\_ERROR\_IF\_NOT\_EXISTS</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">NO\_ERROR\_IF\_NOT\_EXISTS</span></div>

                <div className="block">
                  Whether or not to suppress the error if the specified backup does not exist. Supported values:

                  <ul>
                    <li><a href="#TRUE"><code>TRUE</code></a> </li>
                    <li><a href="#FALSE"><code>FALSE</code></a> </li>
                  </ul>

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

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

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

            <li>
              <div className="section detail" id="TRUE">
                <h3>TRUE</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">TRUE</span></div>

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

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

            <li>
              <div className="section detail" id="FALSE">
                <h3>FALSE</h3>
                <div className="member-signature"><span className="modifiers">public static final</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">FALSE</span></div>

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

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