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

# CreateBackupRequest.Options

> CreateBackupRequest.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 CreateBackupRequest.Options" className="title">Class CreateBackupRequest.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.CreateBackupRequest.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/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</a></code></div>
    </div>

    <hr />

    <div className="type-signature"><span className="modifiers">public static final class </span><span className="element-name type-name-label">CreateBackupRequest.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/CreateBackupRequest" title="class in com.gpudb.protocol"><code>CreateBackupRequest</code></a> parameter <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest#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="#CHECKSUM" className="member-name-link">CHECKSUM</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Whether or not to calculate checksums for backup files.</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="#COMMENT" className="member-name-link">COMMENT</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Comments to store with this backup.</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="#DDL_ONLY" className="member-name-link">DDL\_ONLY</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Whether or not, for tables, to only backup DDL and not table data.</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="#DELETE_INTERMEDIATE_BACKUPS" className="member-name-link">DELETE\_INTERMEDIATE\_BACKUPS</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Whether or not to delete any intermediate snapshots when the <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest#getBackupType()"><code>backupType</code></a> is set to <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#DIFFERENTIAL"><code>DIFFERENTIAL</code></a>.</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="#DRY_RUN" className="member-name-link">DRY\_RUN</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Whether or not to perform a dry run of a backup operation.</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="#FALSE" className="member-name-link">FALSE</a></code></div>
            <div className="col-last odd-row-color"> </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="#MAX_INCREMENTAL_BACKUPS_TO_KEEP" className="member-name-link">MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">Maximum number of incremental snapshots to keep.</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="#RECREATE" className="member-name-link">RECREATE</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists.</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="CHECKSUM">
                <h3>CHECKSUM</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">CHECKSUM</span></div>

                <div className="block">
                  Whether or not to calculate checksums for backup files. 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.CreateBackupRequest.Options.CHECKSUM">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.CreateBackupRequest.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.CreateBackupRequest.Options.FALSE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="COMMENT">
                <h3>COMMENT</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">COMMENT</span></div>
                <div className="block">Comments to store with this backup.</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.CreateBackupRequest.Options.COMMENT">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="DDL_ONLY">
                <h3>DDL\_ONLY</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">DDL\_ONLY</span></div>

                <div className="block">
                  Whether or not, for tables, to only backup DDL and not table data. Supported values:

                  <ul>
                    <li><a href="#TRUE"><code>TRUE</code></a>: For tables, only back up DDL, not data. </li>
                    <li><a href="#FALSE"><code>FALSE</code></a>: For tables, back up DDL and data. </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.CreateBackupRequest.Options.DDL_ONLY">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="DELETE_INTERMEDIATE_BACKUPS">
                <h3>DELETE\_INTERMEDIATE\_BACKUPS</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">DELETE\_INTERMEDIATE\_BACKUPS</span></div>

                <div className="block">
                  Whether or not to delete any intermediate snapshots when the <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest#getBackupType()"><code>backupType</code></a> is set to <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#DIFFERENTIAL"><code>DIFFERENTIAL</code></a>. 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.CreateBackupRequest.Options.DELETE_INTERMEDIATE_BACKUPS">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="DRY_RUN">
                <h3>DRY\_RUN</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">DRY\_RUN</span></div>

                <div className="block">
                  Whether or not to perform a dry run of a backup operation. 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.CreateBackupRequest.Options.DRY_RUN">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="MAX_INCREMENTAL_BACKUPS_TO_KEEP">
                <h3>MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP</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">MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP</span></div>
                <div className="block">Maximum number of incremental snapshots to keep. The default value is '-1'.</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.CreateBackupRequest.Options.MAX_INCREMENTAL_BACKUPS_TO_KEEP">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="RECREATE">
                <h3>RECREATE</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">RECREATE</span></div>

                <div className="block">
                  Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. 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.CreateBackupRequest.Options.RECREATE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>
          </ul>
        </div>
      </li>
    </ul>
  </div>
</div>