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

> CreateBackupRequest — 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" className="title">Class CreateBackupRequest</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</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">CreateBackupRequest</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#createBackup(com.gpudb.protocol.CreateBackupRequest)"><code>GPUdb.createBackup</code></a>.
      <p> Creates a database <a href="/content/admin/backup_restore/#database-backup" target="_top">backup</a>, containing a snapshot of existing objects, at the remote file store accessible via the <a href="/content/concepts/data_sinks/" target="_top">data sink</a> specified by <a href="#getDatasinkName()"><code>datasinkName</code></a>.</p>
    </div>
  </div>

  <div className="section summary">
    <ul className="summary-list">
      <li>
        <div className="section nested-class-summary" id="nested-class-summary">
          <h2>Nested Class Summary</h2>
          <div className="caption"><span>Nested Classes</span></div>

          <div className="summary-table three-column-summary">
            <div className="table-header col-first">Modifier and Type</div>
            <div className="table-header col-second">Class</div>
            <div className="table-header col-last">Description</div>
            <div className="col-first even-row-color"><code>static final class </code></div>
            <div className="col-second even-row-color"><code><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap" className="type-name-link" title="class in com.gpudb.protocol">CreateBackupRequest.BackupObjectsMap</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/CreateBackupRequest" title="class in com.gpudb.protocol"><code>CreateBackupRequest</code></a> parameter <a href="#getBackupObjectsMap()"><code>backupObjectsMap</code></a>.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final class </code></div>
            <div className="col-second odd-row-color"><code><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType" className="type-name-link" title="class in com.gpudb.protocol">CreateBackupRequest.BackupType</a></code></div>

            <div className="col-last odd-row-color">
              <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="#getBackupType()"><code>backupType</code></a>.</div>
            </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/CreateBackupRequest.Options" className="type-name-link" title="class in com.gpudb.protocol">CreateBackupRequest.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/CreateBackupRequest" title="class in com.gpudb.protocol"><code>CreateBackupRequest</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">CreateBackupRequest</a>()</code></div>

            <div className="col-last even-row-color">
              <div className="block">Constructs a CreateBackupRequest 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.util.Map,java.lang.String,java.util.Map)" className="member-name-link">CreateBackupRequest</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> backupName, <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> backupType, <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>> backupObjectsMap, <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> datasinkName, <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 CreateBackupRequest 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-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="#getBackupName()" className="member-name-link">getBackupName</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 for this backup.</div>
                </div>

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

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.</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="#getBackupType()" className="member-name-link">getBackupType</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Type of snapshot to create.</div>
                </div>

                <div className="col-first odd-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 odd-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 odd-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 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="#getDatasinkName()" className="member-name-link">getDatasinkName</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Data sink through which the backup will be stored.</div>
                </div>

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

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

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.avro.Schema</code></div>
                <div className="col-second even-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 even-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 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>void</code></div>
                <div className="col-second even-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 even-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBackupName(java.lang.String)" className="member-name-link">setBackupName</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> backupName)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Name for this backup.</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/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBackupObjectsMap(java.util.Map)" className="member-name-link">setBackupObjectsMap</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>> backupObjectsMap)</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.</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/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBackupType(java.lang.String)" className="member-name-link">setBackupType</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> backupType)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Type of snapshot to create.</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/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDatasinkName(java.lang.String)" className="member-name-link">setDatasinkName</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> datasinkName)</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Data sink through which the backup will be stored.</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/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</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="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>CreateBackupRequest</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">CreateBackupRequest</span>()</div>
                <div className="block">Constructs a CreateBackupRequest object with default parameters.</div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(java.lang.String,java.lang.String,java.util.Map,java.lang.String,java.util.Map)">
                <h3>CreateBackupRequest</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">CreateBackupRequest</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> backupName, <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> backupType, <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>> backupObjectsMap, <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> datasinkName, <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 CreateBackupRequest object with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>backupName</code> - Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#RECREATE"><code>RECREATE</code></a> is set to <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a>.</div>

                  <div className="dd">
                    <code>backupType</code> - Type of snapshot to create. Supported values:

                    <ul>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#DIFFERENTIAL"><code>DIFFERENTIAL</code></a>: Snapshot of changes in the database objects and data since the last full snapshot. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#FULL"><code>FULL</code></a>: Snapshot of the given database objects and data. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#INCREMENTAL"><code>INCREMENTAL</code></a>: Snapshot of changes in the database objects and data since the last snapshot of any kind. </li>
                    </ul>
                  </div>

                  <div className="dd">
                    <code>backupObjectsMap</code> - Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.

                    <ul>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#ALL"><code>ALL</code></a>: All object types and data contained in the given <a href="/content/concepts/schemas/" target="_top">schema(s)</a>. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CATALOG"><code>CATALOG</code></a>: Data Lake catalog that is external to the database. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CONTEXT"><code>CONTEXT</code></a>: <a href="/content/sql-gpt/concepts/#sql-gpt-context" target="_top">Context(s)</a>. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CREDENTIAL"><code>CREDENTIAL</code></a>: <a href="/content/concepts/credentials/" target="_top">Credential(s)</a>. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#DATASINK"><code>DATASINK</code></a>: <a href="/content/concepts/data_sinks/" target="_top">Data sink(s)</a>. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#DATASOURCE"><code>DATASOURCE</code></a>: <a href="/content/concepts/data_sources/" target="_top">Data source(s)</a>. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#FUNCTION_ENVIRONMENT"><code>FUNCTION\_ENVIRONMENT</code></a>: <a href="/content/udf/python/writing/#udf-python-func-env" target="_top">Python UDF function environment(s)</a>. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#GRAPH"><code>GRAPH</code></a>: <a href="/content/graph_solver/network_graph_solver/" target="_top">Graph(s)</a> definition. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#MONITOR"><code>MONITOR</code></a>: <a href="/content/concepts/table_monitors/" target="_top">Table monitor(s)</a> / <a href="/content/sql/ddl/#create-stream" target="_top">SQL stream(s)</a>. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#RESOURCE_GROUP"><code>RESOURCE\_GROUP</code></a>: <a href="/content/rm/concepts/#resource-groups" target="_top">Resource group(s)</a>. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#ROLE"><code>ROLE</code></a>: <a href="/content/security/sec_concepts/#roles" target="_top">Role(s)</a>, role members (roles or users, recursively), and associated permissions. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#STORED_PROCEDURE"><code>STORED\_PROCEDURE</code></a>: <a href="/content/sql/procedure/" target="_top">SQL procedure(s)</a>. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#TABLE"><code>TABLE</code></a>: <a href="/content/concepts/tables/" target="_top">Table(s)</a> and <a href="/content/sql/ddl/#create-view" target="_top">SQL view(s)</a>. Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#USER"><code>USER</code></a>: <a href="/content/security/sec_concepts/#security-concepts-users" target="_top">User(s)</a> (internal and external) and associated permissions. </li>
                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#USER_DEFINED_FUNCTION"><code>USER\_DEFINED\_FUNCTION</code></a>: <a href="/content/udf_overview" target="_top">UDF(s)</a>. </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="dd"><code>datasinkName</code> - Data sink through which the backup will be stored.</div>

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

                    <ul>
                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#CHECKSUM"><code>CHECKSUM</code></a>: Whether or not to calculate checksums for backup files. Supported values:

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

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

                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#COMMENT"><code>COMMENT</code></a>: Comments to store with this backup. </li>

                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DDL_ONLY"><code>DDL\_ONLY</code></a>: Whether or not, for tables, to only backup DDL and not table data. Supported values:

                        <ul>
                          <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a>: For tables, only back up DDL, not data. </li>
                          <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a>: For tables, back up DDL and data. </li>
                        </ul>

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

                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DELETE_INTERMEDIATE_BACKUPS"><code>DELETE\_INTERMEDIATE\_BACKUPS</code></a>: Whether or not to delete any intermediate snapshots when the <code>backupType</code> is set to <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#DIFFERENTIAL"><code>DIFFERENTIAL</code></a>. Supported values:

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

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

                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: Whether or not to perform a dry run of a backup operation. Supported values:

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

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

                      <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#MAX_INCREMENTAL_BACKUPS_TO_KEEP"><code>MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP</code></a>: Maximum number of incremental snapshots to keep. The default value is '-1'. </li>

                      <li>
                        <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#RECREATE"><code>RECREATE</code></a>: 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="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a> </li>
                          <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a> </li>
                        </ul>

                        The default value is <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a>.
                      </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="getBackupName()">
                <h3>getBackupName</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">getBackupName</span>()</div>
                <div className="block">Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#RECREATE"><code>RECREATE</code></a> is set to <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a>.</div>

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

            <li>
              <div className="section detail" id="setBackupName(java.lang.String)">
                <h3>setBackupName</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</a></span> <span className="element-name">setBackupName</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> backupName)</span></div>
                <div className="block">Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#RECREATE"><code>RECREATE</code></a> is set to <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a>.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>backupName</code> - The new value for <code>backupName</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="getBackupType()">
                <h3>getBackupType</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">getBackupType</span>()</div>

                <div className="block">
                  Type of snapshot to create. Supported values:

                  <ul>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#DIFFERENTIAL"><code>DIFFERENTIAL</code></a>: Snapshot of changes in the database objects and data since the last full snapshot. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#FULL"><code>FULL</code></a>: Snapshot of the given database objects and data. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#INCREMENTAL"><code>INCREMENTAL</code></a>: Snapshot of changes in the database objects and data since the last snapshot of any kind. </li>
                  </ul>
                </div>

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

            <li>
              <div className="section detail" id="setBackupType(java.lang.String)">
                <h3>setBackupType</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</a></span> <span className="element-name">setBackupType</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> backupType)</span></div>

                <div className="block">
                  Type of snapshot to create. Supported values:

                  <ul>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#DIFFERENTIAL"><code>DIFFERENTIAL</code></a>: Snapshot of changes in the database objects and data since the last full snapshot. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#FULL"><code>FULL</code></a>: Snapshot of the given database objects and data. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#INCREMENTAL"><code>INCREMENTAL</code></a>: Snapshot of changes in the database objects and data since the last snapshot of any kind. </li>
                  </ul>
                </div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>backupType</code> - The new value for <code>backupType</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="getBackupObjectsMap()">
                <h3>getBackupObjectsMap</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">getBackupObjectsMap</span>()</div>

                <div className="block">
                  Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.

                  <ul>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#ALL"><code>ALL</code></a>: All object types and data contained in the given <a href="/content/concepts/schemas/" target="_top">schema(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CATALOG"><code>CATALOG</code></a>: Data Lake catalog that is external to the database. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CONTEXT"><code>CONTEXT</code></a>: <a href="/content/sql-gpt/concepts/#sql-gpt-context" target="_top">Context(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CREDENTIAL"><code>CREDENTIAL</code></a>: <a href="/content/concepts/credentials/" target="_top">Credential(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#DATASINK"><code>DATASINK</code></a>: <a href="/content/concepts/data_sinks/" target="_top">Data sink(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#DATASOURCE"><code>DATASOURCE</code></a>: <a href="/content/concepts/data_sources/" target="_top">Data source(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#FUNCTION_ENVIRONMENT"><code>FUNCTION\_ENVIRONMENT</code></a>: <a href="/content/udf/python/writing/#udf-python-func-env" target="_top">Python UDF function environment(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#GRAPH"><code>GRAPH</code></a>: <a href="/content/graph_solver/network_graph_solver/" target="_top">Graph(s)</a> definition. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#MONITOR"><code>MONITOR</code></a>: <a href="/content/concepts/table_monitors/" target="_top">Table monitor(s)</a> / <a href="/content/sql/ddl/#create-stream" target="_top">SQL stream(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#RESOURCE_GROUP"><code>RESOURCE\_GROUP</code></a>: <a href="/content/rm/concepts/#resource-groups" target="_top">Resource group(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#ROLE"><code>ROLE</code></a>: <a href="/content/security/sec_concepts/#roles" target="_top">Role(s)</a>, role members (roles or users, recursively), and associated permissions. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#STORED_PROCEDURE"><code>STORED\_PROCEDURE</code></a>: <a href="/content/sql/procedure/" target="_top">SQL procedure(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#TABLE"><code>TABLE</code></a>: <a href="/content/concepts/tables/" target="_top">Table(s)</a> and <a href="/content/sql/ddl/#create-view" target="_top">SQL view(s)</a>. Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#USER"><code>USER</code></a>: <a href="/content/security/sec_concepts/#security-concepts-users" target="_top">User(s)</a> (internal and external) and associated permissions. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#USER_DEFINED_FUNCTION"><code>USER\_DEFINED\_FUNCTION</code></a>: <a href="/content/udf_overview" target="_top">UDF(s)</a>. </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>backupObjectsMap</code>.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="setBackupObjectsMap(java.util.Map)">
                <h3>setBackupObjectsMap</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</a></span> <span className="element-name">setBackupObjectsMap</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>> backupObjectsMap)</span></div>

                <div className="block">
                  Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.

                  <ul>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#ALL"><code>ALL</code></a>: All object types and data contained in the given <a href="/content/concepts/schemas/" target="_top">schema(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CATALOG"><code>CATALOG</code></a>: Data Lake catalog that is external to the database. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CONTEXT"><code>CONTEXT</code></a>: <a href="/content/sql-gpt/concepts/#sql-gpt-context" target="_top">Context(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CREDENTIAL"><code>CREDENTIAL</code></a>: <a href="/content/concepts/credentials/" target="_top">Credential(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#DATASINK"><code>DATASINK</code></a>: <a href="/content/concepts/data_sinks/" target="_top">Data sink(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#DATASOURCE"><code>DATASOURCE</code></a>: <a href="/content/concepts/data_sources/" target="_top">Data source(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#FUNCTION_ENVIRONMENT"><code>FUNCTION\_ENVIRONMENT</code></a>: <a href="/content/udf/python/writing/#udf-python-func-env" target="_top">Python UDF function environment(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#GRAPH"><code>GRAPH</code></a>: <a href="/content/graph_solver/network_graph_solver/" target="_top">Graph(s)</a> definition. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#MONITOR"><code>MONITOR</code></a>: <a href="/content/concepts/table_monitors/" target="_top">Table monitor(s)</a> / <a href="/content/sql/ddl/#create-stream" target="_top">SQL stream(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#RESOURCE_GROUP"><code>RESOURCE\_GROUP</code></a>: <a href="/content/rm/concepts/#resource-groups" target="_top">Resource group(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#ROLE"><code>ROLE</code></a>: <a href="/content/security/sec_concepts/#roles" target="_top">Role(s)</a>, role members (roles or users, recursively), and associated permissions. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#STORED_PROCEDURE"><code>STORED\_PROCEDURE</code></a>: <a href="/content/sql/procedure/" target="_top">SQL procedure(s)</a>. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#TABLE"><code>TABLE</code></a>: <a href="/content/concepts/tables/" target="_top">Table(s)</a> and <a href="/content/sql/ddl/#create-view" target="_top">SQL view(s)</a>. Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#USER"><code>USER</code></a>: <a href="/content/security/sec_concepts/#security-concepts-users" target="_top">User(s)</a> (internal and external) and associated permissions. </li>
                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#USER_DEFINED_FUNCTION"><code>USER\_DEFINED\_FUNCTION</code></a>: <a href="/content/udf_overview" target="_top">UDF(s)</a>. </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>backupObjectsMap</code> - The new value for <code>backupObjectsMap</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="getDatasinkName()">
                <h3>getDatasinkName</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">getDatasinkName</span>()</div>
                <div className="block">Data sink through which the backup will be stored.</div>

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

            <li>
              <div className="section detail" id="setDatasinkName(java.lang.String)">
                <h3>setDatasinkName</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</a></span> <span className="element-name">setDatasinkName</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> datasinkName)</span></div>
                <div className="block">Data sink through which the backup will be stored.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>datasinkName</code> - The new value for <code>datasinkName</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/CreateBackupRequest.Options#CHECKSUM"><code>CHECKSUM</code></a>: Whether or not to calculate checksums for backup files. Supported values:

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

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

                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#COMMENT"><code>COMMENT</code></a>: Comments to store with this backup. </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DDL_ONLY"><code>DDL\_ONLY</code></a>: Whether or not, for tables, to only backup DDL and not table data. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a>: For tables, only back up DDL, not data. </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a>: For tables, back up DDL and data. </li>
                      </ul>

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

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DELETE_INTERMEDIATE_BACKUPS"><code>DELETE\_INTERMEDIATE\_BACKUPS</code></a>: Whether or not to delete any intermediate snapshots when the <a href="#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="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a> </li>
                      </ul>

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

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: Whether or not to perform a dry run of a backup operation. Supported values:

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

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

                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#MAX_INCREMENTAL_BACKUPS_TO_KEEP"><code>MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP</code></a>: Maximum number of incremental snapshots to keep. The default value is '-1'. </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#RECREATE"><code>RECREATE</code></a>: 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="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a> </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a>.
                    </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/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</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/CreateBackupRequest.Options#CHECKSUM"><code>CHECKSUM</code></a>: Whether or not to calculate checksums for backup files. Supported values:

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

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

                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#COMMENT"><code>COMMENT</code></a>: Comments to store with this backup. </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DDL_ONLY"><code>DDL\_ONLY</code></a>: Whether or not, for tables, to only backup DDL and not table data. Supported values:

                      <ul>
                        <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a>: For tables, only back up DDL, not data. </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a>: For tables, back up DDL and data. </li>
                      </ul>

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

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DELETE_INTERMEDIATE_BACKUPS"><code>DELETE\_INTERMEDIATE\_BACKUPS</code></a>: Whether or not to delete any intermediate snapshots when the <a href="#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="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a> </li>
                      </ul>

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

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: Whether or not to perform a dry run of a backup operation. Supported values:

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

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

                    <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#MAX_INCREMENTAL_BACKUPS_TO_KEEP"><code>MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP</code></a>: Maximum number of incremental snapshots to keep. The default value is '-1'. </li>

                    <li>
                      <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#RECREATE"><code>RECREATE</code></a>: 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="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a> </li>
                        <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a> </li>
                      </ul>

                      The default value is <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a>.
                    </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>