> ## 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.

# showResourceGroups

<div className="kinetica-doxygen">
  <div id="a378c6b54b2b4795e17ba59fe12110633" />

  <h2 className="memtitle"><span className="permalink"><a href="#a378c6b54b2b4795e17ba59fe12110633">◆ </a></span>showResourceGroups() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">ShowResourceGroupsResponse</a> gpudb::GPUdb::showResourceGroups </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsRequest">ShowResourceGroupsRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Requests resource group properties. </p>
      <p>Returns detailed information about the requested resource groups.</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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="add609fa998cd62bb51ad9795c4e9f897" />

  <h2 className="memtitle"><span className="permalink"><a href="#add609fa998cd62bb51ad9795c4e9f897">◆ </a></span>showResourceGroups() <span className="overload">\[2/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">ShowResourceGroupsResponse</a> & gpudb::GPUdb::showResourceGroups </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsRequest">ShowResourceGroupsRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">ShowResourceGroupsResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Requests resource group properties. </p>
      <p>Returns detailed information about the requested resource groups.</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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a726aae68f00a46595368ee7f5a3f4ec9" />

  <h2 className="memtitle"><span className="permalink"><a href="#a726aae68f00a46595368ee7f5a3f4ec9">◆ </a></span>showResourceGroups() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">ShowResourceGroupsResponse</a> gpudb::GPUdb::showResourceGroups </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> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Requests resource group properties. </p>
      <p>Returns detailed information about the requested resource groups.</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>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a1181eebb9d511dd63c8c978476c8e89b" />

  <h2 className="memtitle"><span className="permalink"><a href="#a1181eebb9d511dd63c8c978476c8e89b">◆ </a></span>showResourceGroups() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">ShowResourceGroupsResponse</a> & gpudb::GPUdb::showResourceGroups </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>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">ShowResourceGroupsResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Requests resource group properties. </p>
      <p>Returns detailed information about the requested resource groups.</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>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceGroupsResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>