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

> gpudb::ShowResourceGroupsRequest — 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#a378c6b54b2b4795e17ba59fe12110633">GPUdb::showResourceGroups</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/show__resource__groups_8h_source">gpudb/protocol/show\_resource\_groups.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:a39b6c34d99b0f58c1c77864c233af6ed" id="r_a39b6c34d99b0f58c1c77864c233af6ed">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a39b6c34d99b0f58c1c77864c233af6ed">ShowResourceGroupsRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a39b6c34d99b0f58c1c77864c233af6ed">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsRequest" title="A set of parameters for GPUdb::showResourceGroups.">ShowResourceGroupsRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:ad05008d6e6af5de14967ccc483210fb9" id="r_ad05008d6e6af5de14967ccc483210fb9">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad05008d6e6af5de14967ccc483210fb9">ShowResourceGroupsRequest</a> (const std::vector\< std::string > \&names\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:ad05008d6e6af5de14967ccc483210fb9">
        <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:a70ef436ae2dc1a07986ac3288f9b1214" id="r_a70ef436ae2dc1a07986ac3288f9b1214">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a70ef436ae2dc1a07986ac3288f9b1214">names</a></td>
      </tr>

      <tr className="memdesc:a70ef436ae2dc1a07986ac3288f9b1214">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">List of names of groups to be shown. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a5b1a0fe7bb50a40c51d8e1a71d007e33">
        <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#a378c6b54b2b4795e17ba59fe12110633">GPUdb::showResourceGroups</a>. </p>
      <p>Requests resource group properties. Returns detailed information about the requested resource groups. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__resource__groups_8h_source#l00019">19</a> of file <a className="el" href="/content/api/cpp/show__resource__groups_8h_source">show\_resource\_groups.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a39b6c34d99b0f58c1c77864c233af6ed">◆ </a></span>ShowResourceGroupsRequest() <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::ShowResourceGroupsRequest::ShowResourceGroupsRequest </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_1ShowResourceGroupsRequest" title="A set of parameters for GPUdb::showResourceGroups.">ShowResourceGroupsRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__resource__groups_8h_source#l00025">25</a> of file <a className="el" href="/content/api/cpp/show__resource__groups_8h_source">show\_resource\_groups.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ad05008d6e6af5de14967ccc483210fb9">◆ </a></span>ShowResourceGroupsRequest() <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::ShowResourceGroupsRequest::ShowResourceGroupsRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">names\_</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_1ShowResourceGroupsRequest" title="A set of parameters for GPUdb::showResourceGroups.">ShowResourceGroupsRequest</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">names\_</td>
                <td>List of names of groups to be shown. A single entry with an empty string returns all groups. </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#a833517c8c044c706f5f41c953c15ccd7">show\_resource\_groups\_show\_default\_values</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">true</a> include values of fields that are based on the default resource group. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">show\_resource\_groups\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#acea27e6ab09c00ff04331e9ffac27447">show\_resource\_groups\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">show\_resource\_groups\_true</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a43527f4db3b1b92867362d128cbd5297">show\_resource\_groups\_show\_default\_group</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">true</a> include the default and system resource groups in the response. This value defaults to false if an explicit list of group names is provided, and true otherwise. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">show\_resource\_groups\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#acea27e6ab09c00ff04331e9ffac27447">show\_resource\_groups\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">show\_resource\_groups\_true</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a3ec409936a7718d4c378f9e2d6050e2e">show\_resource\_groups\_show\_tier\_usage</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">true</a> include the resource group usage on the worker ranks in the response. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">show\_resource\_groups\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#acea27e6ab09c00ff04331e9ffac27447">show\_resource\_groups\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#acea27e6ab09c00ff04331e9ffac27447">show\_resource\_groups\_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/show__resource__groups_8h_source#l00102">102</a> of file <a className="el" href="/content/api/cpp/show__resource__groups_8h_source">show\_resource\_groups.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> gpudb::ShowResourceGroupsRequest::names</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>List of names of groups to be shown. </p>
        <p>A single entry with an empty string returns all groups. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__resource__groups_8h_source#l00112">112</a> of file <a className="el" href="/content/api/cpp/show__resource__groups_8h_source">show\_resource\_groups.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a833517c8c044c706f5f41c953c15ccd7">show\_resource\_groups\_show\_default\_values</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">true</a> include values of fields that are based on the default resource group. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">show\_resource\_groups\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#acea27e6ab09c00ff04331e9ffac27447">show\_resource\_groups\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">show\_resource\_groups\_true</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a43527f4db3b1b92867362d128cbd5297">show\_resource\_groups\_show\_default\_group</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">true</a> include the default and system resource groups in the response. This value defaults to false if an explicit list of group names is provided, and true otherwise. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">show\_resource\_groups\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#acea27e6ab09c00ff04331e9ffac27447">show\_resource\_groups\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">show\_resource\_groups\_true</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a3ec409936a7718d4c378f9e2d6050e2e">show\_resource\_groups\_show\_tier\_usage</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">true</a> include the resource group usage on the worker ranks in the response. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad4b3a02d3ee642e2843160475c7b0303">show\_resource\_groups\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#acea27e6ab09c00ff04331e9ffac27447">show\_resource\_groups\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#acea27e6ab09c00ff04331e9ffac27447">show\_resource\_groups\_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/show__resource__groups_8h_source#l00161">161</a> of file <a className="el" href="/content/api/cpp/show__resource__groups_8h_source">show\_resource\_groups.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__resource__groups_8h_source">show\_resource\_groups.h</a></li>
    </ul>
  </div>
</div>