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

> gpudb::AlterRoleRequest — 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#afa8f2a294e46d5e721e16056e6decd6a">GPUdb::alterRole</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/alter__role_8h_source">gpudb/protocol/alter\_role.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:a8f8eab8db824fd84f2c70ef222e3a10e" id="r_a8f8eab8db824fd84f2c70ef222e3a10e">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8f8eab8db824fd84f2c70ef222e3a10e">AlterRoleRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a8f8eab8db824fd84f2c70ef222e3a10e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterRoleRequest" title="A set of parameters for GPUdb::alterRole.">AlterRoleRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a4a70ee3605bff6de74bf6df6d2733185" id="r_a4a70ee3605bff6de74bf6df6d2733185">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4a70ee3605bff6de74bf6df6d2733185">AlterRoleRequest</a> (const std::string \&name\_, const std::string \&action\_, const std::string \&value\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a4a70ee3605bff6de74bf6df6d2733185">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterRoleRequest" title="A set of parameters for GPUdb::alterRole.">AlterRoleRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="memdesc:a2f958e12fc5f8a02c012c8e2d1b0b918">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the role to be altered. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a822794771af2bf8c957aaca410660d91">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Modification operation to be applied to the role. <br /></td>
      </tr>

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

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

      <tr className="memdesc:af62e955a4ba4af441a9f1199d15048d4">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The value of the modification, depending on <a className="el" href="#a822794771af2bf8c957aaca410660d91">action</a>. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a9048258c29f8c4326b34c7a394fd3311">
        <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#afa8f2a294e46d5e721e16056e6decd6a">GPUdb::alterRole</a>. </p>
      <p>Alters a Role. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__role_8h_source#l00017">17</a> of file <a className="el" href="/content/api/cpp/alter__role_8h_source">alter\_role.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a8f8eab8db824fd84f2c70ef222e3a10e">◆ </a></span>AlterRoleRequest() <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::AlterRoleRequest::AlterRoleRequest </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 an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterRoleRequest" title="A set of parameters for GPUdb::alterRole.">AlterRoleRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__role_8h_source#l00022">22</a> of file <a className="el" href="/content/api/cpp/alter__role_8h_source">alter\_role.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4a70ee3605bff6de74bf6df6d2733185">◆ </a></span>AlterRoleRequest() <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::AlterRoleRequest::AlterRoleRequest </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::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">action\_</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">value\_</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 an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterRoleRequest" title="A set of parameters for GPUdb::alterRole.">AlterRoleRequest</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 role to be altered. Must be an existing role. </td>
              </tr>

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

                <td>
                  Modification operation to be applied to the role. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3ffa1862e6873d815b78b757ce5f5bc9">alter\_role\_set\_comment</a>: Sets the comment for an internal role. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a503f073cf4cf7d2b914c42b2250546b8">alter\_role\_set\_resource\_group</a>: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group. </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">value\_</td>
                <td>The value of the modification, depending on <span className="em arg">action\_</span>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>
                <td>Optional parameters. 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/alter__role_8h_source#l00055">55</a> of file <a className="el" href="/content/api/cpp/alter__role_8h_source">alter\_role.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Modification operation to be applied to the role. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3ffa1862e6873d815b78b757ce5f5bc9">alter\_role\_set\_comment</a>: Sets the comment for an internal role. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a503f073cf4cf7d2b914c42b2250546b8">alter\_role\_set\_resource\_group</a>: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__role_8h_source#l00081">81</a> of file <a className="el" href="/content/api/cpp/alter__role_8h_source">alter\_role.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the role to be altered. </p>
        <p>Must be an existing role. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__role_8h_source#l00066">66</a> of file <a className="el" href="/content/api/cpp/alter__role_8h_source">alter\_role.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Optional parameters. </p>
        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__role_8h_source#l00091">91</a> of file <a className="el" href="/content/api/cpp/alter__role_8h_source">alter\_role.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af62e955a4ba4af441a9f1199d15048d4">◆ </a></span>value</h2>

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

      <div className="memdoc">
        <p>The value of the modification, depending on <a className="el" href="#a822794771af2bf8c957aaca410660d91">action</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__role_8h_source#l00086">86</a> of file <a className="el" href="/content/api/cpp/alter__role_8h_source">alter\_role.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/alter__role_8h_source">alter\_role.h</a></li>
    </ul>
  </div>
</div>