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

# gpudb::AdminHaOfflineRequest

> gpudb::AdminHaOfflineRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#abe3d7c0c7fc2acb14bdc22e030dee0b5">GPUdb::adminHaOffline</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/admin__ha__offline_8h_source">gpudb/protocol/admin\_ha\_offline.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

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

      <tr className="memdesc:addf17a6b4fc9db17967099cbbebfccc1">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineRequest" title="A set of parameters for GPUdb::adminHaOffline.">AdminHaOfflineRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:aa59cc1679ec03f6d2d1e8bff8b824566" id="r_aa59cc1679ec03f6d2d1e8bff8b824566">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa59cc1679ec03f6d2d1e8bff8b824566">AdminHaOfflineRequest</a> (const bool offline\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:aa59cc1679ec03f6d2d1e8bff8b824566">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AdminHaOfflineRequest" title="A set of parameters for GPUdb::adminHaOffline.">AdminHaOfflineRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:aa4bfd5c8d34cd57ee85d93890b61a63b" id="r_aa4bfd5c8d34cd57ee85d93890b61a63b">
        <td className="memItemLeft" align="right" valign="top">bool </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa4bfd5c8d34cd57ee85d93890b61a63b">offline</a></td>
      </tr>

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

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

      <tr className="memitem:aef1bb3e90665257f3429e3f36a6a4126" id="r_aef1bb3e90665257f3429e3f36a6a4126">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aef1bb3e90665257f3429e3f36a6a4126">options</a></td>
      </tr>

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

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

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

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#abe3d7c0c7fc2acb14bdc22e030dee0b5">GPUdb::adminHaOffline</a>. </p>
      <p>Pauses consumption of messages from other HA clusters to support data repair/recovery scenarios. In-flight queries may fail to replicate to other clusters in the ring when going offline. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__ha__offline_8h_source#l00020">20</a> of file <a className="el" href="/content/api/cpp/admin__ha__offline_8h_source">admin\_ha\_offline.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#addf17a6b4fc9db17967099cbbebfccc1">◆ </a></span>AdminHaOfflineRequest() <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">gpudb::AdminHaOfflineRequest::AdminHaOfflineRequest </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/cpp/structgpudb_1_1AdminHaOfflineRequest" title="A set of parameters for GPUdb::adminHaOffline.">AdminHaOfflineRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__ha__offline_8h_source#l00025">25</a> of file <a className="el" href="/content/api/cpp/admin__ha__offline_8h_source">admin\_ha\_offline.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aa59cc1679ec03f6d2d1e8bff8b824566">◆ </a></span>AdminHaOfflineRequest() <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">gpudb::AdminHaOfflineRequest::AdminHaOfflineRequest </td>
                  <td>(</td>
                  <td className="paramtype">const bool</td>
                  <td className="paramname"><span className="paramname"><span className="em">offline\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></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/cpp/structgpudb_1_1AdminHaOfflineRequest" title="A set of parameters for GPUdb::adminHaOffline.">AdminHaOfflineRequest</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="paramdir">\[in]</td>
                <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="paramdir">\[in]</td>
                <td className="paramname">options\_</td>
                <td>Optional parameters. The default value is an empty map. </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__ha__offline_8h_source#l00044">44</a> of file <a className="el" href="/content/api/cpp/admin__ha__offline_8h_source">admin\_ha\_offline.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#aa4bfd5c8d34cd57ee85d93890b61a63b">◆ </a></span>offline</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">bool gpudb::AdminHaOfflineRequest::offline</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="/content/api/cpp/admin__ha__offline_8h_source#l00058">58</a> of file <a className="el" href="/content/api/cpp/admin__ha__offline_8h_source">admin\_ha\_offline.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::AdminHaOfflineRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>
        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/admin__ha__offline_8h_source#l00063">63</a> of file <a className="el" href="/content/api/cpp/admin__ha__offline_8h_source">admin\_ha\_offline.h</a>.</p>
      </div>
    </div>

    <hr />

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

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/admin__ha__offline_8h_source">admin\_ha\_offline.h</a></li>
    </ul>
  </div>
</div>