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

> gpudb::CreateEnvironmentRequest — 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#ae45e294adbb6e195ee0c90b06f8bdf93">GPUdb::createEnvironment</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__environment_8h_source">gpudb/protocol/create\_environment.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:a00021b6217adb2440efe8cd17a8b1102" id="r_a00021b6217adb2440efe8cd17a8b1102">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a00021b6217adb2440efe8cd17a8b1102">CreateEnvironmentRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a00021b6217adb2440efe8cd17a8b1102">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateEnvironmentRequest" title="A set of parameters for GPUdb::createEnvironment.">CreateEnvironmentRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a268122a38b14b59c8d624beb7bb66e06">
        <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:a3f26d2d14c0883cb163a2da8317121fd" id="r_a3f26d2d14c0883cb163a2da8317121fd">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a3f26d2d14c0883cb163a2da8317121fd">environmentName</a></td>
      </tr>

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

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

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

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

      <tr className="separator:a74b79f7260ba65cba0bb2b9f486a6ec9">
        <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#ae45e294adbb6e195ee0c90b06f8bdf93">GPUdb::createEnvironment</a>. </p>
      <p>Creates a new environment which can be used by <a href="/content/concepts/udf/" target="_top">user-defined functions</a> (UDF). </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__environment_8h_source#l00020">20</a> of file <a className="el" href="/content/api/cpp/create__environment_8h_source">create\_environment.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a00021b6217adb2440efe8cd17a8b1102">◆ </a></span>CreateEnvironmentRequest() <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::CreateEnvironmentRequest::CreateEnvironmentRequest </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_1CreateEnvironmentRequest" title="A set of parameters for GPUdb::createEnvironment.">CreateEnvironmentRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__environment_8h_source#l00026">26</a> of file <a className="el" href="/content/api/cpp/create__environment_8h_source">create\_environment.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a268122a38b14b59c8d624beb7bb66e06">◆ </a></span>CreateEnvironmentRequest() <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::CreateEnvironmentRequest::CreateEnvironmentRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">environmentName\_</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_1CreateEnvironmentRequest" title="A set of parameters for GPUdb::createEnvironment.">CreateEnvironmentRequest</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">environmentName\_</td>
                <td>Name of the environment to be created. </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/create__environment_8h_source#l00040">40</a> of file <a className="el" href="/content/api/cpp/create__environment_8h_source">create\_environment.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the environment to be created. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__environment_8h_source#l00049">49</a> of file <a className="el" href="/content/api/cpp/create__environment_8h_source">create\_environment.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::CreateEnvironmentRequest::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/create__environment_8h_source#l00054">54</a> of file <a className="el" href="/content/api/cpp/create__environment_8h_source">create\_environment.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__environment_8h_source">create\_environment.h</a></li>
    </ul>
  </div>
</div>