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

> gpudb::ShowResourceObjectsRequest — 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#a88a53f3f53aea0fe34c7952f8ed1706b">GPUdb::showResourceObjects</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/show__resource__objects_8h_source">gpudb/protocol/show\_resource\_objects.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:a14334affa8d47b0ed226c02fb60d97ca" id="r_a14334affa8d47b0ed226c02fb60d97ca">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a14334affa8d47b0ed226c02fb60d97ca">ShowResourceObjectsRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a14334affa8d47b0ed226c02fb60d97ca">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowResourceObjectsRequest" title="A set of parameters for GPUdb::showResourceObjects.">ShowResourceObjectsRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a50d99c02cce9da8d8555c4984556a2f4">
        <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:aaa0c05067efa1d6b54f6319f1f1ecc9a" id="r_aaa0c05067efa1d6b54f6319f1f1ecc9a">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aaa0c05067efa1d6b54f6319f1f1ecc9a">options</a></td>
      </tr>

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

      <tr className="separator:aaa0c05067efa1d6b54f6319f1f1ecc9a">
        <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#a88a53f3f53aea0fe34c7952f8ed1706b">GPUdb::showResourceObjects</a>. </p>
      <p>Returns information about the internal sub-components (tiered objects) which use resources of the system. The request can either return results from actively used objects (default) or it can be used to query the status of the objects of a given list of tables. Returns detailed information about the requested resource objects. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__resource__objects_8h_source#l00022">22</a> of file <a className="el" href="/content/api/cpp/show__resource__objects_8h_source">show\_resource\_objects.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a14334affa8d47b0ed226c02fb60d97ca">◆ </a></span>ShowResourceObjectsRequest() <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::ShowResourceObjectsRequest::ShowResourceObjectsRequest </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_1ShowResourceObjectsRequest" title="A set of parameters for GPUdb::showResourceObjects.">ShowResourceObjectsRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__resource__objects_8h_source#l00028">28</a> of file <a className="el" href="/content/api/cpp/show__resource__objects_8h_source">show\_resource\_objects.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a50d99c02cce9da8d8555c4984556a2f4">◆ </a></span>ShowResourceObjectsRequest() <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::ShowResourceObjectsRequest::ShowResourceObjectsRequest </td>
                  <td>(</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>
                  <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_1ShowResourceObjectsRequest" title="A set of parameters for GPUdb::showResourceObjects.">ShowResourceObjectsRequest</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">options\_</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0b31f7927a9cdef08acde42fac2dc7c1">show\_resource\_objects\_tiers</a>: Comma-separated list of tiers to query, leave blank for all tiers. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#abe8884a0f27b77a621f21f69efb31a61">show\_resource\_objects\_expression</a>: An expression to filter the returned objects. Expression is limited to the following operators: =,!=,\<,\<=,>,>=,+,-,\*,AND,OR,LIKE. For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>. To use a more complex expression, query the ki\_catalog.ki\_tiered\_objects table directly. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a152200d6a93427bfc232f77884df44e5">show\_resource\_objects\_order\_by</a>: Single column to be sorted by as well as the sort direction, e.g., 'size asc'. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a31ae0a48d4c457c0a8cf801caf34aa71">show\_resource\_objects\_size</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8d7422ed6c4189882ccec4170f3cc034">show\_resource\_objects\_id</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae086d1a79371642793bf32d742661a0f">show\_resource\_objects\_priority</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#adbfbaea531c8282d5c7da78ebd8883de">show\_resource\_objects\_tier</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aaa47cf3e378428e1118ae1bfdb29781a">show\_resource\_objects\_evictable</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aba35326e39fb3b1e3ad223367fdce581">show\_resource\_objects\_locked</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4051d562714f5a17066db0a6136e2ce5">show\_resource\_objects\_pin\_count</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aacfe747e0197153a6c2990495ae0af8c">show\_resource\_objects\_ram\_evictions</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a48edb205f372f4c9543db5d056d6e205">show\_resource\_objects\_persist\_evictions</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4bdb2a4b223ae81acb82bc8358396523">show\_resource\_objects\_owner\_resource\_group</a> </li>
                      </ul>
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a45ce4ae09004d8893864404b4da9e211">show\_resource\_objects\_limit</a>: An integer indicating the maximum number of results to be returned, per rank, or (-1) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the <a href="/content/config/#config-main-general" target="_top">max\_get\_records\_size</a> parameter in the server configuration. The default value is '100'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5386e5737131544d28ca31856d222a1c">show\_resource\_objects\_table\_names</a>: Comma-separated list of tables to restrict the results to. Use '\*' to show all tables. </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__objects_8h_source#l00117">117</a> of file <a className="el" href="/content/api/cpp/show__resource__objects_8h_source">show\_resource\_objects.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0b31f7927a9cdef08acde42fac2dc7c1">show\_resource\_objects\_tiers</a>: Comma-separated list of tiers to query, leave blank for all tiers. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#abe8884a0f27b77a621f21f69efb31a61">show\_resource\_objects\_expression</a>: An expression to filter the returned objects. Expression is limited to the following operators: =,!=,\<,\<=,>,>=,+,-,\*,AND,OR,LIKE. For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>. To use a more complex expression, query the ki\_catalog.ki\_tiered\_objects table directly. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a152200d6a93427bfc232f77884df44e5">show\_resource\_objects\_order\_by</a>: Single column to be sorted by as well as the sort direction, e.g., 'size asc'. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a31ae0a48d4c457c0a8cf801caf34aa71">show\_resource\_objects\_size</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8d7422ed6c4189882ccec4170f3cc034">show\_resource\_objects\_id</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae086d1a79371642793bf32d742661a0f">show\_resource\_objects\_priority</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#adbfbaea531c8282d5c7da78ebd8883de">show\_resource\_objects\_tier</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aaa47cf3e378428e1118ae1bfdb29781a">show\_resource\_objects\_evictable</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aba35326e39fb3b1e3ad223367fdce581">show\_resource\_objects\_locked</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4051d562714f5a17066db0a6136e2ce5">show\_resource\_objects\_pin\_count</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aacfe747e0197153a6c2990495ae0af8c">show\_resource\_objects\_ram\_evictions</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a48edb205f372f4c9543db5d056d6e205">show\_resource\_objects\_persist\_evictions</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4bdb2a4b223ae81acb82bc8358396523">show\_resource\_objects\_owner\_resource\_group</a> </li>
            </ul>
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a45ce4ae09004d8893864404b4da9e211">show\_resource\_objects\_limit</a>: An integer indicating the maximum number of results to be returned, per rank, or (-1) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the <a href="/content/config/#config-main-general" target="_top">max\_get\_records\_size</a> parameter in the server configuration. The default value is '100'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5386e5737131544d28ca31856d222a1c">show\_resource\_objects\_table\_names</a>: Comma-separated list of tables to restrict the results to. Use '\*' to show all tables. </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__objects_8h_source#l00179">179</a> of file <a className="el" href="/content/api/cpp/show__resource__objects_8h_source">show\_resource\_objects.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__objects_8h_source">show\_resource\_objects.h</a></li>
    </ul>
  </div>
</div>