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

> gpudb::CreateResourceGroupRequest — 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#a5b9733fe84adc0498c9bf18e758c5eb0">GPUdb::createResourceGroup</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__resource__group_8h_source">gpudb/protocol/create\_resource\_group.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:a3e1a549ca939f8ef1c11d911487b6d4e" id="r_a3e1a549ca939f8ef1c11d911487b6d4e">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a3e1a549ca939f8ef1c11d911487b6d4e">CreateResourceGroupRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a3e1a549ca939f8ef1c11d911487b6d4e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateResourceGroupRequest" title="A set of parameters for GPUdb::createResourceGroup.">CreateResourceGroupRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a5882a7c01978dccdc41a0277ef85e487" id="r_a5882a7c01978dccdc41a0277ef85e487">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a5882a7c01978dccdc41a0277ef85e487">CreateResourceGroupRequest</a> (const std::string \&name\_, const std::map\< std::string, std::map\< std::string, std::string > > \&tierAttributes\_, const std::string \&ranking\_, const std::string \&adjoiningResourceGroup\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:a5882a7c01978dccdc41a0277ef85e487">
        <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:acd4f918215e94d1df8407b5edbfbb707" id="r_acd4f918215e94d1df8407b5edbfbb707">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#acd4f918215e94d1df8407b5edbfbb707">name</a></td>
      </tr>

      <tr className="memdesc:acd4f918215e94d1df8407b5edbfbb707">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the group to be created. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a98178ce4be6e406affc6fb00952d3582">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional map containing tier names and their respective attribute group limits. <br /></td>
      </tr>

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

      <tr className="memitem:ad96243e7e513cc77b99559bf6a001b49" id="r_ad96243e7e513cc77b99559bf6a001b49">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad96243e7e513cc77b99559bf6a001b49">ranking</a></td>
      </tr>

      <tr className="memdesc:ad96243e7e513cc77b99559bf6a001b49">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Indicates the relative ranking among existing resource groups where this new resource group will be placed. <br /></td>
      </tr>

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

      <tr className="memitem:a0eba1a2176199c1ae019bfae9743b4ee" id="r_a0eba1a2176199c1ae019bfae9743b4ee">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a0eba1a2176199c1ae019bfae9743b4ee">adjoiningResourceGroup</a></td>
      </tr>

      <tr className="memdesc:a0eba1a2176199c1ae019bfae9743b4ee">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If <a className="el" href="#ad96243e7e513cc77b99559bf6a001b49">ranking</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a2e6ea8bae76e6ecdaf1bc66875aed809">before</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a10613cdce7c914801d14867748404ce4">after</a>, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a047880b581d96cb1b5cb10af75e3a133">
        <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#a5b9733fe84adc0498c9bf18e758c5eb0">GPUdb::createResourceGroup</a>. </p>
      <p>Creates a new resource group to facilitate resource management. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__resource__group_8h_source#l00018">18</a> of file <a className="el" href="/content/api/cpp/create__resource__group_8h_source">create\_resource\_group.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a3e1a549ca939f8ef1c11d911487b6d4e">◆ </a></span>CreateResourceGroupRequest() <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::CreateResourceGroupRequest::CreateResourceGroupRequest </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_1CreateResourceGroupRequest" title="A set of parameters for GPUdb::createResourceGroup.">CreateResourceGroupRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__resource__group_8h_source#l00024">24</a> of file <a className="el" href="/content/api/cpp/create__resource__group_8h_source">create\_resource\_group.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a5882a7c01978dccdc41a0277ef85e487">◆ </a></span>CreateResourceGroupRequest() <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::CreateResourceGroupRequest::CreateResourceGroupRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">name\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::map\< std::string, std::string > > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tierAttributes\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">ranking\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">adjoiningResourceGroup\_</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_1CreateResourceGroupRequest" title="A set of parameters for GPUdb::createResourceGroup.">CreateResourceGroupRequest</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">name\_</td>
                <td>Name of the group to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">tierAttributes\_</td>

                <td>
                  Optional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max\_memory (in bytes) for the VRAM and RAM tiers. For instance, to set max VRAM capacity to 1GB per rank per GPU and max RAM capacity to 10GB per rank, use: {"{"}'VRAM':{"{"}'max\_memory':'1000000000'{"}"}, 'RAM':{"{"}'max\_memory':'10000000000'{"}"}{"}"}.

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a46256c5b2b7d17f82d34d56aa2eb63a6">create\_resource\_group\_max\_memory</a>: Maximum amount of memory usable at one time, per rank, per GPU, for the VRAM tier; or maximum amount of memory usable at one time, per rank, for the RAM tier. </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">ranking\_</td>

                <td>
                  Indicates the relative ranking among existing resource groups where this new resource group will be placed. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac5bb1528b1a84c729473792fb5af64a5">create\_resource\_group\_first</a>: Make this resource group the new first one in the ordering. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#abf91eedff3c72004de21ee001e9c49bc">create\_resource\_group\_last</a>: Make this resource group the new last one in the ordering. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2e6ea8bae76e6ecdaf1bc66875aed809">create\_resource\_group\_before</a>: Place this resource group before the one specified by <span className="em arg">adjoiningResourceGroup\_</span> in the ordering. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a10613cdce7c914801d14867748404ce4">create\_resource\_group\_after</a>: Place this resource group after the one specified by <span className="em arg">adjoiningResourceGroup\_</span> in the ordering. </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">adjoiningResourceGroup\_</td>
                <td>If <span className="em arg">ranking\_</span> is <a className="el" href="/content/api/cpp/namespacegpudb#a2e6ea8bae76e6ecdaf1bc66875aed809">before</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a10613cdce7c914801d14867748404ce4">after</a>, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. 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#a6e5ec8607af26c730ee8a7744f387e0c">create\_resource\_group\_max\_cpu\_concurrency</a>: Maximum number of simultaneous threads that will be used to execute a request, per rank, for this group. The minimum allowed value is '4'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ada60c2354d13090e5faa68c13b1eff6f">create\_resource\_group\_max\_data</a>: Maximum amount of data, per rank, in bytes, that can be used by all database objects within this group. Set to -1 to indicate no upper limit. The minimum allowed value is '-1'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a23adc70a319623ac82546966068d1701">create\_resource\_group\_max\_scheduling\_priority</a>: Maximum priority of a scheduled task for this group. The minimum allowed value is '1'. The maximum allowed value is '100'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9693f7ca4fc7bc1e426f5a13288fec6c">create\_resource\_group\_max\_tier\_priority</a>: Maximum priority of a tiered object for this group. The minimum allowed value is '1'. The maximum allowed value is '10'. </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/create__resource__group_8h_source#l00131">131</a> of file <a className="el" href="/content/api/cpp/create__resource__group_8h_source">create\_resource\_group.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>If <a className="el" href="#ad96243e7e513cc77b99559bf6a001b49">ranking</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a2e6ea8bae76e6ecdaf1bc66875aed809">before</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a10613cdce7c914801d14867748404ce4">after</a>, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. </p>
        <p>The default value is ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__resource__group_8h_source#l00196">196</a> of file <a className="el" href="/content/api/cpp/create__resource__group_8h_source">create\_resource\_group.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#acd4f918215e94d1df8407b5edbfbb707">◆ </a></span>name</h2>

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

      <div className="memdoc">
        <p>Name of the group to be created. </p>
        <p>Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__resource__group_8h_source#l00145">145</a> of file <a className="el" href="/content/api/cpp/create__resource__group_8h_source">create\_resource\_group.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6e5ec8607af26c730ee8a7744f387e0c">create\_resource\_group\_max\_cpu\_concurrency</a>: Maximum number of simultaneous threads that will be used to execute a request, per rank, for this group. The minimum allowed value is '4'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ada60c2354d13090e5faa68c13b1eff6f">create\_resource\_group\_max\_data</a>: Maximum amount of data, per rank, in bytes, that can be used by all database objects within this group. Set to -1 to indicate no upper limit. The minimum allowed value is '-1'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a23adc70a319623ac82546966068d1701">create\_resource\_group\_max\_scheduling\_priority</a>: Maximum priority of a scheduled task for this group. The minimum allowed value is '1'. The maximum allowed value is '100'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9693f7ca4fc7bc1e426f5a13288fec6c">create\_resource\_group\_max\_tier\_priority</a>: Maximum priority of a tiered object for this group. The minimum allowed value is '1'. The maximum allowed value is '10'. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__resource__group_8h_source#l00222">222</a> of file <a className="el" href="/content/api/cpp/create__resource__group_8h_source">create\_resource\_group.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ad96243e7e513cc77b99559bf6a001b49">◆ </a></span>ranking</h2>

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

      <div className="memdoc">
        <p>Indicates the relative ranking among existing resource groups where this new resource group will be placed. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac5bb1528b1a84c729473792fb5af64a5">create\_resource\_group\_first</a>: Make this resource group the new first one in the ordering. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#abf91eedff3c72004de21ee001e9c49bc">create\_resource\_group\_last</a>: Make this resource group the new last one in the ordering. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2e6ea8bae76e6ecdaf1bc66875aed809">create\_resource\_group\_before</a>: Place this resource group before the one specified by <a className="el" href="#a0eba1a2176199c1ae019bfae9743b4ee">adjoiningResourceGroup</a> in the ordering. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a10613cdce7c914801d14867748404ce4">create\_resource\_group\_after</a>: Place this resource group after the one specified by <a className="el" href="#a0eba1a2176199c1ae019bfae9743b4ee">adjoiningResourceGroup</a> in the ordering. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__resource__group_8h_source#l00188">188</a> of file <a className="el" href="/content/api/cpp/create__resource__group_8h_source">create\_resource\_group.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a98178ce4be6e406affc6fb00952d3582">◆ </a></span>tierAttributes</h2>

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

      <div className="memdoc">
        <p>Optional map containing tier names and their respective attribute group limits. </p>
        <p>The only valid attribute limit that can be set is max\_memory (in bytes) for the VRAM and RAM tiers.</p>
        <p>For instance, to set max VRAM capacity to 1GB per rank per GPU and max RAM capacity to 10GB per rank, use: {"{"}'VRAM':{"{"}'max\_memory':'1000000000'{"}"}, 'RAM':{"{"}'max\_memory':'10000000000'{"}"}{"}"}. </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a46256c5b2b7d17f82d34d56aa2eb63a6">create\_resource\_group\_max\_memory</a>: Maximum amount of memory usable at one time, per rank, per GPU, for the VRAM tier; or maximum amount of memory usable at one time, per rank, for the RAM tier. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__resource__group_8h_source#l00165">165</a> of file <a className="el" href="/content/api/cpp/create__resource__group_8h_source">create\_resource\_group.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/create__resource__group_8h_source">create\_resource\_group.h</a></li>
    </ul>
  </div>
</div>