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

> kinetica.AdminOfflineRequest — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica/adminoffline#a882db0cc0becff6a6fa84423929e8bae">Kinetica.adminOffline</a>. <a href="#details">More...</a></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="nested-classes" />

            Classes
          </h2>
        </td>
      </tr>

      <tr className="memitem:">
        <td className="memItemLeft" align="right" valign="top">struct  </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Offline">Offline</a></td>
      </tr>

      <tr className="memdesc:">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A set of string constants for the parameter <a className="el" href="#abc364b2476de9e0b493840f671e00d77" title="Set to true if desired state is offline.">AdminOfflineRequest.offline</a>. <a href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Offline#details">More...</a><br /></td>
      </tr>

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

      <tr className="memitem:">
        <td className="memItemLeft" align="right" valign="top">struct  </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options">Options</a></td>
      </tr>

      <tr className="memdesc:">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A set of string constants for the parameter <a className="el" href="#a85724bbf433f759d20963d069423d9c4" title="Optional parameters.">AdminOfflineRequest.options</a>. <a href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#details">More...</a><br /></td>
      </tr>

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

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

            Public Member Functions
          </h2>
        </td>
      </tr>

      <tr className="memitem:a2dd22441b32cc16098e80d309037b400" id="r_a2dd22441b32cc16098e80d309037b400">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a2dd22441b32cc16098e80d309037b400">AdminOfflineRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a2dd22441b32cc16098e80d309037b400">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cs/classkinetica_1_1AdminOfflineRequest" title="A set of parameters for Kinetica.adminOffline.">AdminOfflineRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:aebbfd5d5692f68a65e693e82bee2845f" id="r_aebbfd5d5692f68a65e693e82bee2845f">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aebbfd5d5692f68a65e693e82bee2845f">AdminOfflineRequest</a> (bool <a className="el" href="#abc364b2476de9e0b493840f671e00d77">offline</a>, IDictionary\< string, string > <a className="el" href="#a85724bbf433f759d20963d069423d9c4">options</a>=null)</td>
      </tr>

      <tr className="memdesc:aebbfd5d5692f68a65e693e82bee2845f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cs/classkinetica_1_1AdminOfflineRequest" title="A set of parameters for Kinetica.adminOffline.">AdminOfflineRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="inherit_header pub_methods_classkinetica_1_1KineticaData">
        <td colSpan="2"> Public Member Functions inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData" id="r_a6a494237f126f79a7f478b7614323482">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a6a494237f126f79a7f478b7614323482">KineticaData</a> (<a className="el" href="/content/api/cs/classkinetica_1_1KineticaType">KineticaType</a> type)</td>
      </tr>

      <tr className="memdesc:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructor from <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> Type. <br /></td>
      </tr>

      <tr className="separator:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData" id="r_ac8cbdce08f2dd7d0d02bf0f279d79b79">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ac8cbdce08f2dd7d0d02bf0f279d79b79">KineticaData</a> (System.Type type=null)</td>
      </tr>

      <tr className="memdesc:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Default constructor, with optional System.Type. <br /></td>
      </tr>

      <tr className="separator:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData" id="r_a8fceb0fc6b641ef28b7548bc2820e48f">
        <td className="memItemLeft" align="right" valign="top">object </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a8fceb0fc6b641ef28b7548bc2820e48f">Get</a> (int fieldPos)</td>
      </tr>

      <tr className="memdesc:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Retrieve a specific property from this object. <br /></td>
      </tr>

      <tr className="separator:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData" id="r_ad02b0bac0aa3f8a64b0ec46a94bd06f0">
        <td className="memItemLeft" align="right" valign="top">void </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ad02b0bac0aa3f8a64b0ec46a94bd06f0">Put</a> (int fieldPos, object fieldValue)</td>
      </tr>

      <tr className="memdesc:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Write a specific property to this object. <br /></td>
      </tr>

      <tr className="separator:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="properties" />

            Properties
          </h2>
        </td>
      </tr>

      <tr className="memitem:abc364b2476de9e0b493840f671e00d77" id="r_abc364b2476de9e0b493840f671e00d77">
        <td className="memItemLeft" align="right" valign="top">bool </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#abc364b2476de9e0b493840f671e00d77">offline</a><code> \[get, set]</code></td>
      </tr>

      <tr className="memdesc:abc364b2476de9e0b493840f671e00d77">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Set to true if desired state is offline. <br /></td>
      </tr>

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

      <tr className="memitem:a85724bbf433f759d20963d069423d9c4" id="r_a85724bbf433f759d20963d069423d9c4">
        <td className="memItemLeft" align="right" valign="top">IDictionary\< string, string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a85724bbf433f759d20963d069423d9c4">options</a> = new Dictionary\<string, string>()<code> \[get, set]</code></td>
      </tr>

      <tr className="memdesc:a85724bbf433f759d20963d069423d9c4">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

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

      <tr className="inherit_header properties_classkinetica_1_1KineticaData">
        <td colSpan="2"> Properties inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:ae35f20177341ed020cb1c92195621499 inherit properties_classkinetica_1_1KineticaData" id="r_ae35f20177341ed020cb1c92195621499">
        <td className="memItemLeft" align="right" valign="top">Schema </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ae35f20177341ed020cb1c92195621499">Schema</a><code> \[get]</code></td>
      </tr>

      <tr className="memdesc:ae35f20177341ed020cb1c92195621499 inherit properties_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Avro Schema for this class. <br /></td>
      </tr>

      <tr className="separator:ae35f20177341ed020cb1c92195621499 inherit properties_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="inherited" />

            Additional Inherited Members
          </h2>
        </td>
      </tr>

      <tr className="inherit_header pub_static_methods_classkinetica_1_1KineticaData">
        <td colSpan="2"> Static Public Member Functions inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData" id="r_a9474d49c9399dbe86f31a3ba07ff4691">
        <td className="memItemLeft" align="right" valign="top">static ? RecordSchema </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a9474d49c9399dbe86f31a3ba07ff4691">SchemaFromType</a> (System.Type t, <a className="el" href="/content/api/cs/classkinetica_1_1KineticaType">KineticaType</a>? ktype=null)</td>
      </tr>

      <tr className="memdesc:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Create an Avro Schema from a System.Type and a <a className="el" href="/content/api/cs/classkinetica_1_1KineticaType" title="Describes a Kinetica record type — its columns, properties, and Avro schema — and can create the type...">KineticaType</a>. <br /></td>
      </tr>

      <tr className="separator:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <div id="details" />

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

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica/adminoffline#a882db0cc0becff6a6fa84423929e8bae">Kinetica.adminOffline</a>. </p>
      <p>Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.</p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminOffline.cs#L17">17</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminOffline.cs">AdminOffline.cs</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>

    <div id="a2dd22441b32cc16098e80d309037b400" />

    <h2 className="memtitle"><span className="permalink"><a href="#a2dd22441b32cc16098e80d309037b400">◆ </a></span>AdminOfflineRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">kinetica.AdminOfflineRequest.AdminOfflineRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Constructs an <a className="el" href="/content/api/cs/classkinetica_1_1AdminOfflineRequest" title="A set of parameters for Kinetica.adminOffline.">AdminOfflineRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminOffline.cs#L101">101</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminOffline.cs">AdminOffline.cs</a>.</p>
      </div>
    </div>

    <div id="aebbfd5d5692f68a65e693e82bee2845f" />

    <h2 className="memtitle"><span className="permalink"><a href="#aebbfd5d5692f68a65e693e82bee2845f">◆ </a></span>AdminOfflineRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">kinetica.AdminOfflineRequest.AdminOfflineRequest </td>
                  <td>(</td>
                  <td className="paramtype">bool</td>
                  <td className="paramname"><span className="paramname"><span className="em">offline</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">IDictionary\< string, string ></td>
                  <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span> )</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Constructs an <a className="el" href="/content/api/cs/classkinetica_1_1AdminOfflineRequest" title="A set of parameters for Kinetica.adminOffline.">AdminOfflineRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramname">offline</td>

                <td>
                  Set to true if desired state is offline. Supported values:

                  <ul>
                    <li> true </li>
                    <li> false </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramname">options</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#afa5c499419c638f03681c825b12d24a6">FLUSH\_TO\_DISK</a>: Flush to disk when going offline. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#ac7a65a814e7a719010f50f565485545b">TRUE</a> </li>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#ac6efef5d844ce30b2d9090f0ba47b1fe">FALSE</a> </li>
                      </ul>
                    </li>
                  </ul>

                  The default value is an empty Dictionary.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminOffline.cs#L139">139</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminOffline.cs">AdminOffline.cs</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Property Documentation</h2>

    <div id="abc364b2476de9e0b493840f671e00d77" />

    <h2 className="memtitle"><span className="permalink"><a href="#abc364b2476de9e0b493840f671e00d77">◆ </a></span>offline</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">bool kinetica.AdminOfflineRequest.offline</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Set to true if desired state is offline. </p>
        <p>Supported values:</p>

        <ul>
          <li> true </li>
          <li> false </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminOffline.cs#L72">72</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminOffline.cs">AdminOffline.cs</a>.</p>
      </div>
    </div>

    <div id="a85724bbf433f759d20963d069423d9c4" />

    <h2 className="memtitle"><span className="permalink"><a href="#a85724bbf433f759d20963d069423d9c4">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">IDictionary\<string, string> kinetica.AdminOfflineRequest.options = new Dictionary\<string, string>()</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Optional parameters. </p>

        <ul>
          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#afa5c499419c638f03681c825b12d24a6">FLUSH\_TO\_DISK</a>: Flush to disk when going offline. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#ac7a65a814e7a719010f50f565485545b">TRUE</a> </li>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1AdminOfflineRequest_1_1Options#ac6efef5d844ce30b2d9090f0ba47b1fe">FALSE</a> </li>
            </ul>
          </li>
        </ul>

        <p>The default value is an empty Dictionary.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminOffline.cs#L97">97</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/AdminOffline.cs">AdminOffline.cs</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this class 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/AdminOffline.cs">AdminOffline.cs</a></li>
    </ul>
  </div>
</div>


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