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

> gpudb::KillProcRequest — 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#ac8fff6e61ada09d2fdb3bb336ccc321a">GPUdb::killProc</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/kill__proc_8h_source">gpudb/protocol/kill\_proc.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:a59e27d6c1a18a62b9aeda488a5d59d85" id="r_a59e27d6c1a18a62b9aeda488a5d59d85">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a59e27d6c1a18a62b9aeda488a5d59d85">KillProcRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a59e27d6c1a18a62b9aeda488a5d59d85">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1KillProcRequest" title="A set of parameters for GPUdb::killProc.">KillProcRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a0b98bddfed632d27c867f474f3584181">
        <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:a178afc7cfabf2859f80f516032efdc8f" id="r_a178afc7cfabf2859f80f516032efdc8f">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a178afc7cfabf2859f80f516032efdc8f">runId</a></td>
      </tr>

      <tr className="memdesc:a178afc7cfabf2859f80f516032efdc8f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The run ID of a running proc instance. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a9715d5020e87d71329a6527dc3980fec">
        <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#ac8fff6e61ada09d2fdb3bb336ccc321a">GPUdb::killProc</a>. </p>
      <p>Kills a running proc instance. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/kill__proc_8h_source#l00017">17</a> of file <a className="el" href="/content/api/cpp/kill__proc_8h_source">kill\_proc.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a59e27d6c1a18a62b9aeda488a5d59d85">◆ </a></span>KillProcRequest() <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::KillProcRequest::KillProcRequest </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_1KillProcRequest" title="A set of parameters for GPUdb::killProc.">KillProcRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/kill__proc_8h_source#l00022">22</a> of file <a className="el" href="/content/api/cpp/kill__proc_8h_source">kill\_proc.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a0b98bddfed632d27c867f474f3584181">◆ </a></span>KillProcRequest() <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::KillProcRequest::KillProcRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">runId\_</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_1KillProcRequest" title="A set of parameters for GPUdb::killProc.">KillProcRequest</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">runId\_</td>
                <td>The run ID of a running proc instance. If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ''. </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#aec0d2b5c75f858fa90d8935dcf288ac0">kill\_proc\_run\_tag</a>: If <span className="em arg">runId\_</span> is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aec2cf18c6185bf22d4fa351019b9924e">GPUdb::executeProc</a>. If <span className="em arg">runId\_</span> is not specified, kill the proc instance(s) where a matching run tag was provided to <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aec2cf18c6185bf22d4fa351019b9924e">GPUdb::executeProc</a>. The default value is ''. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#af2eb09468a7ca309a0d5e9a58e7f900c">kill\_proc\_clear\_execute\_at\_startup</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#aa6b24f35474865925a838ba784a12015">true</a>, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned from <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aec2cf18c6185bf22d4fa351019b9924e">GPUdb::executeProc</a> and can be retrieved using <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ae7427428b2214adb5622e723382cb304">GPUdb::showProc</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa6b24f35474865925a838ba784a12015">kill\_proc\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#acaafc8026f131f4d72fe8c3a87e094a6">kill\_proc\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#acaafc8026f131f4d72fe8c3a87e094a6">kill\_proc\_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/kill__proc_8h_source#l00079">79</a> of file <a className="el" href="/content/api/cpp/kill__proc_8h_source">kill\_proc.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aec0d2b5c75f858fa90d8935dcf288ac0">kill\_proc\_run\_tag</a>: If <a className="el" href="#a178afc7cfabf2859f80f516032efdc8f">runId</a> is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aec2cf18c6185bf22d4fa351019b9924e">GPUdb::executeProc</a>. If <a className="el" href="#a178afc7cfabf2859f80f516032efdc8f">runId</a> is not specified, kill the proc instance(s) where a matching run tag was provided to <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aec2cf18c6185bf22d4fa351019b9924e">GPUdb::executeProc</a>. The default value is ''. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#af2eb09468a7ca309a0d5e9a58e7f900c">kill\_proc\_clear\_execute\_at\_startup</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#aa6b24f35474865925a838ba784a12015">true</a>, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned from <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aec2cf18c6185bf22d4fa351019b9924e">GPUdb::executeProc</a> and can be retrieved using <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ae7427428b2214adb5622e723382cb304">GPUdb::showProc</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa6b24f35474865925a838ba784a12015">kill\_proc\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#acaafc8026f131f4d72fe8c3a87e094a6">kill\_proc\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#acaafc8026f131f4d72fe8c3a87e094a6">kill\_proc\_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/kill__proc_8h_source#l00124">124</a> of file <a className="el" href="/content/api/cpp/kill__proc_8h_source">kill\_proc.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a178afc7cfabf2859f80f516032efdc8f">◆ </a></span>runId</h2>

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

      <div className="memdoc">
        <p>The run ID of a running proc instance. </p>
        <p>If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/kill__proc_8h_source#l00091">91</a> of file <a className="el" href="/content/api/cpp/kill__proc_8h_source">kill\_proc.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/kill__proc_8h_source">kill\_proc.h</a></li>
    </ul>
  </div>
</div>