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

> gpudb::AlterTableMonitorRequest — 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#aea7ba4ba63117605613ac472447e3380">GPUdb::alterTableMonitor</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/alter__table__monitor_8h_source">gpudb/protocol/alter\_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:a4ba73e1d7103e88f119d82294ee98a9e" id="r_a4ba73e1d7103e88f119d82294ee98a9e">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4ba73e1d7103e88f119d82294ee98a9e">AlterTableMonitorRequest</a> ()</td>
      </tr>

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

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

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

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

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

      <tr className="memdesc:a3c73474572e68464718109d59a9a3536">
        <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:a3c73474572e68464718109d59a9a3536">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:a8a952cc6a6c15148e83381af65a732be">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Map containing the properties of the table monitor to be updated. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a8f8a8f135977e9b93b69f3fa4f4d624d">
        <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#aea7ba4ba63117605613ac472447e3380">GPUdb::alterTableMonitor</a>. </p>
      <p>Alters 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/alter__table__monitor_8h_source#l00020">20</a> of file <a className="el" href="/content/api/cpp/alter__table__monitor_8h_source">alter\_table\_monitor.h</a>.</p>
    </div>

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

    <h2 className="memtitle"><span className="permalink"><a href="#adc51d9aea4267e19f2ca64933a6d9300">◆ </a></span>AlterTableMonitorRequest() <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::AlterTableMonitorRequest::AlterTableMonitorRequest </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">monitorUpdatesMap\_</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_1AlterTableMonitorRequest" title="A set of parameters for GPUdb::alterTableMonitor.">AlterTableMonitorRequest</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">monitorUpdatesMap\_</td>

                <td>
                  Map containing the properties of the table monitor to be updated. Error if empty.

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a700479d64d4466c3f7fbeab7e7160bdf">alter\_table\_monitor\_schema\_name</a>: Updates the schema name. If <a className="el" href="/content/api/cpp/namespacegpudb#a700479d64d4466c3f7fbeab7e7160bdf">schema\_name</a> doesn't exist, an error will be thrown. If <a className="el" href="/content/api/cpp/namespacegpudb#a700479d64d4466c3f7fbeab7e7160bdf">schema\_name</a> is empty, then the user's default schema will be used. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad27123590acf58dc7b6d0a4a73b8fe8f">alter\_table\_monitor\_max\_consecutive\_failures</a>: Updates the maximum number of consecutive failures before suspending the stream. A value of '-1' to disables auto-suspend. This value is by rank and not overall. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a246d16f19ada92aea10008b331c583c5">alter\_table\_monitor\_notifications</a>: Updates the state of the monitor. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8a46b2271ccd6dc3975dc1b82170fe66">alter\_table\_monitor\_resume</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae9828b3dfdb87c5425e45fce2c9e8f18">alter\_table\_monitor\_suspend</a> </li>
                      </ul>

                      The default value is an empty map.
                    </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/alter__table__monitor_8h_source#l00086">86</a> of file <a className="el" href="/content/api/cpp/alter__table__monitor_8h_source">alter\_table\_monitor.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Map containing the properties of the table monitor to be updated. </p>
        <p>Error if empty. </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a700479d64d4466c3f7fbeab7e7160bdf">alter\_table\_monitor\_schema\_name</a>: Updates the schema name. If <a className="el" href="/content/api/cpp/namespacegpudb#a700479d64d4466c3f7fbeab7e7160bdf">schema\_name</a> doesn't exist, an error will be thrown. If <a className="el" href="/content/api/cpp/namespacegpudb#a700479d64d4466c3f7fbeab7e7160bdf">schema\_name</a> is empty, then the user's default schema will be used. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad27123590acf58dc7b6d0a4a73b8fe8f">alter\_table\_monitor\_max\_consecutive\_failures</a>: Updates the maximum number of consecutive failures before suspending the stream. A value of '-1' to disables auto-suspend. This value is by rank and not overall. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a246d16f19ada92aea10008b331c583c5">alter\_table\_monitor\_notifications</a>: Updates the state of the monitor. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8a46b2271ccd6dc3975dc1b82170fe66">alter\_table\_monitor\_resume</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae9828b3dfdb87c5425e45fce2c9e8f18">alter\_table\_monitor\_suspend</a> </li>
            </ul>

            The default value is an empty map.
          </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__table__monitor_8h_source#l00128">128</a> of file <a className="el" href="/content/api/cpp/alter__table__monitor_8h_source">alter\_table\_monitor.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::AlterTableMonitorRequest::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/alter__table__monitor_8h_source#l00133">133</a> of file <a className="el" href="/content/api/cpp/alter__table__monitor_8h_source">alter\_table\_monitor.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::AlterTableMonitorRequest::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/alter__table__monitor_8h_source#l00098">98</a> of file <a className="el" href="/content/api/cpp/alter__table__monitor_8h_source">alter\_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/alter__table__monitor_8h_source">alter\_table\_monitor.h</a></li>
    </ul>
  </div>
</div>