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

> gpudb::ClearTableMonitorRequest — 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#ad2bf08c0671686d9fd13ec177214fa1c">GPUdb::clearTableMonitor</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/clear__table__monitor_8h_source">gpudb/protocol/clear\_table\_monitor.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:a024d4da295872749004100ffc0469da3" id="r_a024d4da295872749004100ffc0469da3">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a024d4da295872749004100ffc0469da3">ClearTableMonitorRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a024d4da295872749004100ffc0469da3">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ClearTableMonitorRequest" title="A set of parameters for GPUdb::clearTableMonitor.">ClearTableMonitorRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a5d89d0ae8005fe77e6131132124e646a" id="r_a5d89d0ae8005fe77e6131132124e646a">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a5d89d0ae8005fe77e6131132124e646a">ClearTableMonitorRequest</a> (const std::string \&topicId\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a5d89d0ae8005fe77e6131132124e646a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ClearTableMonitorRequest" title="A set of parameters for GPUdb::clearTableMonitor.">ClearTableMonitorRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a5d89d0ae8005fe77e6131132124e646a">
        <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:a1a576f1dd4b6b4c13a9c094bd40bcf58" id="r_a1a576f1dd4b6b4c13a9c094bd40bcf58">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a1a576f1dd4b6b4c13a9c094bd40bcf58">topicId</a></td>
      </tr>

      <tr className="memdesc:a1a576f1dd4b6b4c13a9c094bd40bcf58">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The topic ID returned by <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ab379d6656d94cb2e54be2671ecd05d6c">GPUdb::createTableMonitor</a>. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a65b97056b3e48f95f7207b63dd641ba7">
        <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#ad2bf08c0671686d9fd13ec177214fa1c">GPUdb::clearTableMonitor</a>. </p>
      <p>Deactivates a table monitor previously created with <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ab379d6656d94cb2e54be2671ecd05d6c">GPUdb::createTableMonitor</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/clear__table__monitor_8h_source#l00020">20</a> of file <a className="el" href="/content/api/cpp/clear__table__monitor_8h_source">clear\_table\_monitor.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a024d4da295872749004100ffc0469da3">◆ </a></span>ClearTableMonitorRequest() <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::ClearTableMonitorRequest::ClearTableMonitorRequest </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 a <a className="el" href="/content/api/cpp/structgpudb_1_1ClearTableMonitorRequest" title="A set of parameters for GPUdb::clearTableMonitor.">ClearTableMonitorRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/clear__table__monitor_8h_source#l00026">26</a> of file <a className="el" href="/content/api/cpp/clear__table__monitor_8h_source">clear\_table\_monitor.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a5d89d0ae8005fe77e6131132124e646a">◆ </a></span>ClearTableMonitorRequest() <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::ClearTableMonitorRequest::ClearTableMonitorRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">topicId\_</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 a <a className="el" href="/content/api/cpp/structgpudb_1_1ClearTableMonitorRequest" title="A set of parameters for GPUdb::clearTableMonitor.">ClearTableMonitorRequest</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">topicId\_</td>
                <td>The topic ID returned by <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ab379d6656d94cb2e54be2671ecd05d6c">GPUdb::createTableMonitor</a>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a8961301f127ebf4419ba031ddf28300b">clear\_table\_monitor\_keep\_autogenerated\_sink</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a68f6f1f96002d7596db2f39e56809474">true</a>, the auto-generated <a href="/content/concepts/data_sinks/" target="_top">datasink</a> associated with this monitor, if there is one, will be retained for further use. If <a className="el" href="/content/api/cpp/namespacegpudb#a460ec95af1cc4a386ac3fc320b89f9ef">false</a>, then the auto-generated sink will be dropped if there are no other monitors referencing it. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a68f6f1f96002d7596db2f39e56809474">clear\_table\_monitor\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a460ec95af1cc4a386ac3fc320b89f9ef">clear\_table\_monitor\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a460ec95af1cc4a386ac3fc320b89f9ef">clear\_table\_monitor\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#ad82dfc77a824d33ee9d35ae6b9697609">clear\_table\_monitor\_clear\_all\_references</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a68f6f1f96002d7596db2f39e56809474">true</a>, all references that share the same <span className="em arg">topicId\_</span> will be cleared. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a68f6f1f96002d7596db2f39e56809474">clear\_table\_monitor\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a460ec95af1cc4a386ac3fc320b89f9ef">clear\_table\_monitor\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a460ec95af1cc4a386ac3fc320b89f9ef">clear\_table\_monitor\_false</a>.
                    </li>
                  </ul>

                  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/clear__table__monitor_8h_source#l00087">87</a> of file <a className="el" href="/content/api/cpp/clear__table__monitor_8h_source">clear\_table\_monitor.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a8961301f127ebf4419ba031ddf28300b">clear\_table\_monitor\_keep\_autogenerated\_sink</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a68f6f1f96002d7596db2f39e56809474">true</a>, the auto-generated <a href="/content/concepts/data_sinks/" target="_top">datasink</a> associated with this monitor, if there is one, will be retained for further use. If <a className="el" href="/content/api/cpp/namespacegpudb#a460ec95af1cc4a386ac3fc320b89f9ef">false</a>, then the auto-generated sink will be dropped if there are no other monitors referencing it. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a68f6f1f96002d7596db2f39e56809474">clear\_table\_monitor\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a460ec95af1cc4a386ac3fc320b89f9ef">clear\_table\_monitor\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a460ec95af1cc4a386ac3fc320b89f9ef">clear\_table\_monitor\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ad82dfc77a824d33ee9d35ae6b9697609">clear\_table\_monitor\_clear\_all\_references</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a68f6f1f96002d7596db2f39e56809474">true</a>, all references that share the same <a className="el" href="#a1a576f1dd4b6b4c13a9c094bd40bcf58">topicId</a> will be cleared. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a68f6f1f96002d7596db2f39e56809474">clear\_table\_monitor\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a460ec95af1cc4a386ac3fc320b89f9ef">clear\_table\_monitor\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a460ec95af1cc4a386ac3fc320b89f9ef">clear\_table\_monitor\_false</a>.
          </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/clear__table__monitor_8h_source#l00137">137</a> of file <a className="el" href="/content/api/cpp/clear__table__monitor_8h_source">clear\_table\_monitor.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a1a576f1dd4b6b4c13a9c094bd40bcf58">◆ </a></span>topicId</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::ClearTableMonitorRequest::topicId</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The topic ID returned by <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ab379d6656d94cb2e54be2671ecd05d6c">GPUdb::createTableMonitor</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/clear__table__monitor_8h_source#l00098">98</a> of file <a className="el" href="/content/api/cpp/clear__table__monitor_8h_source">clear\_table\_monitor.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/clear__table__monitor_8h_source">clear\_table\_monitor.h</a></li>
    </ul>
  </div>
</div>
