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

# kinetica.AlterBackupRequest.Options

> kinetica.AlterBackupRequest.Options — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1AlterBackupRequest#a64b0d6e398e59f33c9eb9b3cd92f98cd" title="Optional parameters.">AlterBackupRequest.options</a>. <a href="#details">More...</a></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="pub-static-attribs" />

            Static Public Attributes
          </h2>
        </td>
      </tr>

      <tr className="memitem:a800e96d230e338dbde8eedb6c73ca7ba" id="r_a800e96d230e338dbde8eedb6c73ca7ba">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a800e96d230e338dbde8eedb6c73ca7ba">COMMENT</a> = "comment"</td>
      </tr>

      <tr className="memdesc:a800e96d230e338dbde8eedb6c73ca7ba">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Comments to store with the backup. <br /></td>
      </tr>

      <tr className="separator:a800e96d230e338dbde8eedb6c73ca7ba">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a41847e476c070c48a3a7de90b30d1fd8" id="r_a41847e476c070c48a3a7de90b30d1fd8">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a41847e476c070c48a3a7de90b30d1fd8">DRY\_RUN</a> = "dry\_run"</td>
      </tr>

      <tr className="memdesc:a41847e476c070c48a3a7de90b30d1fd8">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Whether or not to perform a dry run of a backup alteration. <br /></td>
      </tr>

      <tr className="separator:a41847e476c070c48a3a7de90b30d1fd8">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a790d4e0ca82a97165ac1755cda6808f0" id="r_a790d4e0ca82a97165ac1755cda6808f0">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a790d4e0ca82a97165ac1755cda6808f0">TRUE</a> = "true"</td>
      </tr>

      <tr className="memdesc:a790d4e0ca82a97165ac1755cda6808f0">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AlterBackupRequest_1_1Options" title="A set of string constants for the parameter AlterBackupRequest.options.">AlterBackupRequest.Options</a> options. <br /></td>
      </tr>

      <tr className="separator:a790d4e0ca82a97165ac1755cda6808f0">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a96f938f9b3a5142ccee62187dba7c4e6" id="r_a96f938f9b3a5142ccee62187dba7c4e6">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a96f938f9b3a5142ccee62187dba7c4e6">FALSE</a> = "false"</td>
      </tr>

      <tr className="memdesc:a96f938f9b3a5142ccee62187dba7c4e6">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AlterBackupRequest_1_1Options" title="A set of string constants for the parameter AlterBackupRequest.options.">AlterBackupRequest.Options</a> options. <br /></td>
      </tr>

      <tr className="separator:a96f938f9b3a5142ccee62187dba7c4e6">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <div id="details" />

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1AlterBackupRequest#a64b0d6e398e59f33c9eb9b3cd92f98cd" title="Optional parameters.">AlterBackupRequest.options</a>. </p>
      <p>Optional parameters.</p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs#L53">53</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs">AlterBackup.cs</a>.</p>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>

    <div id="a800e96d230e338dbde8eedb6c73ca7ba" />

    <h2 className="memtitle"><span className="permalink"><a href="#a800e96d230e338dbde8eedb6c73ca7ba">◆ </a></span>COMMENT</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AlterBackupRequest.Options.COMMENT = "comment"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Comments to store with the backup. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs#L56">56</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs">AlterBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a41847e476c070c48a3a7de90b30d1fd8" />

    <h2 className="memtitle"><span className="permalink"><a href="#a41847e476c070c48a3a7de90b30d1fd8">◆ </a></span>DRY\_RUN</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AlterBackupRequest.Options.DRY\_RUN = "dry\_run"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Whether or not to perform a dry run of a backup alteration. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a790d4e0ca82a97165ac1755cda6808f0">TRUE</a> </li>
          <li> <a className="el" href="#a96f938f9b3a5142ccee62187dba7c4e6">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#a96f938f9b3a5142ccee62187dba7c4e6">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs#L74">74</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs">AlterBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a96f938f9b3a5142ccee62187dba7c4e6" />

    <h2 className="memtitle"><span className="permalink"><a href="#a96f938f9b3a5142ccee62187dba7c4e6">◆ </a></span>FALSE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AlterBackupRequest.Options.FALSE = "false"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AlterBackupRequest_1_1Options" title="A set of string constants for the parameter AlterBackupRequest.options.">AlterBackupRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs#L82">82</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs">AlterBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a790d4e0ca82a97165ac1755cda6808f0" />

    <h2 className="memtitle"><span className="permalink"><a href="#a790d4e0ca82a97165ac1755cda6808f0">◆ </a></span>TRUE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.AlterBackupRequest.Options.TRUE = "true"</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel static">static</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1AlterBackupRequest_1_1Options" title="A set of string constants for the parameter AlterBackupRequest.options.">AlterBackupRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs#L78">78</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs">AlterBackup.cs</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>Kinetica/Protocol/<a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AlterBackup.cs">AlterBackup.cs</a></li>
    </ul>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.