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

> gpudb::ShowProcStatusRequest — 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#a1d460da9ead16a63d91e8a104805d0a6">GPUdb::showProcStatus</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/show__proc__status_8h_source">gpudb/protocol/show\_proc\_status.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:aeeef816f913a76688201d05d38bb5856" id="r_aeeef816f913a76688201d05d38bb5856">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aeeef816f913a76688201d05d38bb5856">ShowProcStatusRequest</a> ()</td>
      </tr>

      <tr className="memdesc:aeeef816f913a76688201d05d38bb5856">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowProcStatusRequest" title="A set of parameters for GPUdb::showProcStatus.">ShowProcStatusRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

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

      <tr className="memdesc:a8f644dcfcdf8909c19ff764298b16804">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The run ID of a specific proc instance for which the status will be returned. <br /></td>
      </tr>

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

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

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

      <tr className="separator:aad737400e132db42f1b9a45fdaad021c">
        <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#a1d460da9ead16a63d91e8a104805d0a6">GPUdb::showProcStatus</a>. </p>
      <p>Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aec2cf18c6185bf22d4fa351019b9924e">GPUdb::executeProc</a>) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID). </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__proc__status_8h_source#l00022">22</a> of file <a className="el" href="/content/api/cpp/show__proc__status_8h_source">show\_proc\_status.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#aeeef816f913a76688201d05d38bb5856">◆ </a></span>ShowProcStatusRequest() <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::ShowProcStatusRequest::ShowProcStatusRequest </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_1ShowProcStatusRequest" title="A set of parameters for GPUdb::showProcStatus.">ShowProcStatusRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__proc__status_8h_source#l00027">27</a> of file <a className="el" href="/content/api/cpp/show__proc__status_8h_source">show\_proc\_status.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aefdbfdb68201070bcbd154fe4984a62d">◆ </a></span>ShowProcStatusRequest() <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::ShowProcStatusRequest::ShowProcStatusRequest </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_1ShowProcStatusRequest" title="A set of parameters for GPUdb::showProcStatus.">ShowProcStatusRequest</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 specific proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned. 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#ac66483badacbfc643b331dc9a4fa49e4">show\_proc\_status\_clear\_complete</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a52fcd6cd1d56e6a8dab49e68f0749ba5">true</a>, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a52fcd6cd1d56e6a8dab49e68f0749ba5">show\_proc\_status\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a14ba0ef4c12caf314a87db74604ffa80">show\_proc\_status\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a14ba0ef4c12caf314a87db74604ffa80">show\_proc\_status\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a346fcb78bba835a71c440750418aae75">show\_proc\_status\_run\_tag</a>: If <span className="em arg">runId\_</span> is specified, return the status for a 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, return statuses for all proc instances 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>
                  </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/show__proc__status_8h_source#l00083">83</a> of file <a className="el" href="/content/api/cpp/show__proc__status_8h_source">show\_proc\_status.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ac66483badacbfc643b331dc9a4fa49e4">show\_proc\_status\_clear\_complete</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a52fcd6cd1d56e6a8dab49e68f0749ba5">true</a>, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a52fcd6cd1d56e6a8dab49e68f0749ba5">show\_proc\_status\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a14ba0ef4c12caf314a87db74604ffa80">show\_proc\_status\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a14ba0ef4c12caf314a87db74604ffa80">show\_proc\_status\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a346fcb78bba835a71c440750418aae75">show\_proc\_status\_run\_tag</a>: If <a className="el" href="#a8f644dcfcdf8909c19ff764298b16804">runId</a> is specified, return the status for a 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="#a8f644dcfcdf8909c19ff764298b16804">runId</a> is not specified, return statuses for all proc instances 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>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__proc__status_8h_source#l00128">128</a> of file <a className="el" href="/content/api/cpp/show__proc__status_8h_source">show\_proc\_status.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>The run ID of a specific proc instance for which the status will be returned. </p>
        <p>If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned. The default value is ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__proc__status_8h_source#l00095">95</a> of file <a className="el" href="/content/api/cpp/show__proc__status_8h_source">show\_proc\_status.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/show__proc__status_8h_source">show\_proc\_status.h</a></li>
    </ul>
  </div>
</div>