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

# kinetica.AlterEnvironmentRequest

> kinetica.AlterEnvironmentRequest — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica#a147e011a41747d14c151f56deb8d866f">Kinetica.alterEnvironment</a>. <a href="#details">More...</a></p>
    <div id="dynsection-0" className="dynheader closed"> Inheritance diagram for kinetica.AlterEnvironmentRequest:</div>

    <div id="dynsection-0-summary" className="dynsummary" />

    <div id="dynsection-0-content" className="dyncontent">
      <div className="center" />

      <div className="center"><span className="legend">\[<a target="top" href="/content/api/cs/graph_legend">legend</a>]</span></div>
    </div>

    <div id="dynsection-1" className="dynheader closed"> Collaboration diagram for kinetica.AlterEnvironmentRequest:</div>

    <div id="dynsection-1-summary" className="dynsummary" />

    <div id="dynsection-1-content" className="dyncontent">
      <div className="center" />

      <div className="center"><span className="legend">\[<a target="top" href="/content/api/cs/graph_legend">legend</a>]</span></div>
    </div>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Classes</h2>
        </td>
      </tr>

      <tr className="memitem:">
        <td className="memItemLeft" align="right" valign="top">struct  </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action">Action</a></td>
      </tr>

      <tr className="memdesc:">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A set of string constants for the parameter <a className="el" href="#a30c0b8980635eccdebd1b4255f67465c" title="Modification operation to be applied.">AlterEnvironmentRequest.action</a>. <a href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#details">More...</a><br /></td>
      </tr>

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

      <tr className="memitem:">
        <td className="memItemLeft" align="right" valign="top">struct  </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options">Options</a></td>
      </tr>

      <tr className="memdesc:">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A set of string constants for the parameter <a className="el" href="#a015bd610b6fdd88c9c071f2cc8b7fa47" title="Optional parameters.">AlterEnvironmentRequest.options</a>. <a href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#details">More...</a><br /></td>
      </tr>

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

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a6215ce6c1b11d381946654e97753939e" id="r_a6215ce6c1b11d381946654e97753939e">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a6215ce6c1b11d381946654e97753939e">AlterEnvironmentRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a6215ce6c1b11d381946654e97753939e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cs/classkinetica_1_1AlterEnvironmentRequest" title="A set of parameters for Kinetica.alterEnvironment.">AlterEnvironmentRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:ac6596c15c3eea4fedaef982621a47a67" id="r_ac6596c15c3eea4fedaef982621a47a67">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ac6596c15c3eea4fedaef982621a47a67">AlterEnvironmentRequest</a> (string <a className="el" href="#a6607081627072f523c293facdfdf2988">environment\_name</a>, string <a className="el" href="#a30c0b8980635eccdebd1b4255f67465c">action</a>, string <a className="el" href="#a569b5750c387f0aa9d8ac3716c3caecf">\_value</a>, IDictionary\< string, string > <a className="el" href="#a015bd610b6fdd88c9c071f2cc8b7fa47">options</a>=null)</td>
      </tr>

      <tr className="memdesc:ac6596c15c3eea4fedaef982621a47a67">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cs/classkinetica_1_1AlterEnvironmentRequest" title="A set of parameters for Kinetica.alterEnvironment.">AlterEnvironmentRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a6215ce6c1b11d381946654e97753939e" id="r_a6215ce6c1b11d381946654e97753939e">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a6215ce6c1b11d381946654e97753939e">AlterEnvironmentRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a6215ce6c1b11d381946654e97753939e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cs/classkinetica_1_1AlterEnvironmentRequest" title="A set of parameters for Kinetica.alterEnvironment.">AlterEnvironmentRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:ac6596c15c3eea4fedaef982621a47a67" id="r_ac6596c15c3eea4fedaef982621a47a67">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ac6596c15c3eea4fedaef982621a47a67">AlterEnvironmentRequest</a> (string <a className="el" href="#a6607081627072f523c293facdfdf2988">environment\_name</a>, string <a className="el" href="#a30c0b8980635eccdebd1b4255f67465c">action</a>, string <a className="el" href="#a569b5750c387f0aa9d8ac3716c3caecf">\_value</a>, IDictionary\< string, string > <a className="el" href="#a015bd610b6fdd88c9c071f2cc8b7fa47">options</a>=null)</td>
      </tr>

      <tr className="memdesc:ac6596c15c3eea4fedaef982621a47a67">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cs/classkinetica_1_1AlterEnvironmentRequest" title="A set of parameters for Kinetica.alterEnvironment.">AlterEnvironmentRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="inherit_header pub_methods_classkinetica_1_1KineticaData">
        <td colSpan="2"> Public Member Functions inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData" id="r_a6a494237f126f79a7f478b7614323482">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a6a494237f126f79a7f478b7614323482">KineticaData</a> (<a className="el" href="/content/api/cs/classkinetica_1_1KineticaType">KineticaType</a> type)</td>
      </tr>

      <tr className="memdesc:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructor from <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> Type. <br /></td>
      </tr>

      <tr className="separator:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData" id="r_ac8cbdce08f2dd7d0d02bf0f279d79b79">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ac8cbdce08f2dd7d0d02bf0f279d79b79">KineticaData</a> (System.Type type=null)</td>
      </tr>

      <tr className="memdesc:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Default constructor, with optional System.Type. <br /></td>
      </tr>

      <tr className="separator:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData" id="r_a8fceb0fc6b641ef28b7548bc2820e48f">
        <td className="memItemLeft" align="right" valign="top">object </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a8fceb0fc6b641ef28b7548bc2820e48f">Get</a> (int fieldPos)</td>
      </tr>

      <tr className="memdesc:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Retrieve a specific property from this object. <br /></td>
      </tr>

      <tr className="separator:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData" id="r_ad02b0bac0aa3f8a64b0ec46a94bd06f0">
        <td className="memItemLeft" align="right" valign="top">void </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ad02b0bac0aa3f8a64b0ec46a94bd06f0">Put</a> (int fieldPos, object fieldValue)</td>
      </tr>

      <tr className="memdesc:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Write a specific property to this object. <br /></td>
      </tr>

      <tr className="separator:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData" id="r_a6a494237f126f79a7f478b7614323482">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a6a494237f126f79a7f478b7614323482">KineticaData</a> (<a className="el" href="/content/api/cs/classkinetica_1_1KineticaType">KineticaType</a> type)</td>
      </tr>

      <tr className="memdesc:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructor from <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> Type. <br /></td>
      </tr>

      <tr className="separator:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData" id="r_ac8cbdce08f2dd7d0d02bf0f279d79b79">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ac8cbdce08f2dd7d0d02bf0f279d79b79">KineticaData</a> (System.Type type=null)</td>
      </tr>

      <tr className="memdesc:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Default constructor, with optional System.Type. <br /></td>
      </tr>

      <tr className="separator:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData" id="r_a8fceb0fc6b641ef28b7548bc2820e48f">
        <td className="memItemLeft" align="right" valign="top">object </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a8fceb0fc6b641ef28b7548bc2820e48f">Get</a> (int fieldPos)</td>
      </tr>

      <tr className="memdesc:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Retrieve a specific property from this object. <br /></td>
      </tr>

      <tr className="separator:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData" id="r_ad02b0bac0aa3f8a64b0ec46a94bd06f0">
        <td className="memItemLeft" align="right" valign="top">void </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ad02b0bac0aa3f8a64b0ec46a94bd06f0">Put</a> (int fieldPos, object fieldValue)</td>
      </tr>

      <tr className="memdesc:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Write a specific property to this object. <br /></td>
      </tr>

      <tr className="separator:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Properties</h2>
        </td>
      </tr>

      <tr className="memitem:a6607081627072f523c293facdfdf2988" id="r_a6607081627072f523c293facdfdf2988">
        <td className="memItemLeft" align="right" valign="top">string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a6607081627072f523c293facdfdf2988">environment\_name</a><code> \[get, set]</code></td>
      </tr>

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

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

      <tr className="memitem:a30c0b8980635eccdebd1b4255f67465c" id="r_a30c0b8980635eccdebd1b4255f67465c">
        <td className="memItemLeft" align="right" valign="top">string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a30c0b8980635eccdebd1b4255f67465c">action</a><code> \[get, set]</code></td>
      </tr>

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

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

      <tr className="memitem:a569b5750c387f0aa9d8ac3716c3caecf" id="r_a569b5750c387f0aa9d8ac3716c3caecf">
        <td className="memItemLeft" align="right" valign="top">string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a569b5750c387f0aa9d8ac3716c3caecf">\_value</a><code> \[get, set]</code></td>
      </tr>

      <tr className="memdesc:a569b5750c387f0aa9d8ac3716c3caecf">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The value of the modification, depending on <a className="el" href="#a30c0b8980635eccdebd1b4255f67465c" title="Modification operation to be applied.">AlterEnvironmentRequest.action</a>. <br /></td>
      </tr>

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

      <tr className="memitem:a015bd610b6fdd88c9c071f2cc8b7fa47" id="r_a015bd610b6fdd88c9c071f2cc8b7fa47">
        <td className="memItemLeft" align="right" valign="top">IDictionary\< string, string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a015bd610b6fdd88c9c071f2cc8b7fa47">options</a> = new Dictionary\<string, string>()<code> \[get, set]</code></td>
      </tr>

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

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

      <tr className="inherit_header properties_classkinetica_1_1KineticaData">
        <td colSpan="2"> Properties inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:aceefbe60fab98d5b1a834d47056a4e77 inherit properties_classkinetica_1_1KineticaData" id="r_aceefbe60fab98d5b1a834d47056a4e77">
        <td className="memItemLeft" align="right" valign="top">Schema </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#aceefbe60fab98d5b1a834d47056a4e77">Schema</a><code> \[get]</code></td>
      </tr>

      <tr className="memdesc:aceefbe60fab98d5b1a834d47056a4e77 inherit properties_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Avro Schema for this class. <br /></td>
      </tr>

      <tr className="separator:aceefbe60fab98d5b1a834d47056a4e77 inherit properties_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Additional Inherited Members</h2>
        </td>
      </tr>

      <tr className="inherit_header pub_static_methods_classkinetica_1_1KineticaData">
        <td colSpan="2"> Static Public Member Functions inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData" id="r_a9474d49c9399dbe86f31a3ba07ff4691">
        <td className="memItemLeft" align="right" valign="top">static ? RecordSchema </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a9474d49c9399dbe86f31a3ba07ff4691">SchemaFromType</a> (System.Type t, <a className="el" href="/content/api/cs/classkinetica_1_1KineticaType">KineticaType</a>? ktype=null)</td>
      </tr>

      <tr className="memdesc:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Create an Avro Schema from a System.Type and a <a className="el" href="/content/api/cs/classkinetica_1_1KineticaType" title="Describes a Kinetica record type — its columns, properties, and Avro schema — and can create the type...">KineticaType</a>. <br /></td>
      </tr>

      <tr className="separator:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData" id="r_a9474d49c9399dbe86f31a3ba07ff4691">
        <td className="memItemLeft" align="right" valign="top">static ? RecordSchema </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a9474d49c9399dbe86f31a3ba07ff4691">SchemaFromType</a> (System.Type t, <a className="el" href="/content/api/cs/classkinetica_1_1KineticaType">KineticaType</a>? ktype=null)</td>
      </tr>

      <tr className="memdesc:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Create an Avro Schema from a System.Type and a <a className="el" href="/content/api/cs/classkinetica_1_1KineticaType" title="Describes a Kinetica record type — its columns, properties, and Avro schema — and can create the type...">KineticaType</a>. <br /></td>
      </tr>

      <tr className="separator:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData">
        <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/cs/classkinetica_1_1Kinetica#a147e011a41747d14c151f56deb8d866f">Kinetica.alterEnvironment</a>. </p>
      <p>Alters an existing environment which can be referenced by a <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF).</p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source#l00017">17</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a6215ce6c1b11d381946654e97753939e">◆ </a></span>AlterEnvironmentRequest() <span className="overload">\[1/4]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">kinetica.AlterEnvironmentRequest.AlterEnvironmentRequest </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/cs/classkinetica_1_1AlterEnvironmentRequest" title="A set of parameters for Kinetica.alterEnvironment.">AlterEnvironmentRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source#l00143">143</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">kinetica.AlterEnvironmentRequest.AlterEnvironmentRequest </td>
                  <td>(</td>
                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">environment\_name</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">action</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">\_value</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">IDictionary\< string, string ></td>
                  <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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/cs/classkinetica_1_1AlterEnvironmentRequest" title="A set of parameters for Kinetica.alterEnvironment.">AlterEnvironmentRequest</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="paramname">environment\_name</td>
                <td>Name of the environment to be altered. </td>
              </tr>

              <tr>
                <td className="paramname">action</td>

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

                  <ul>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#af32a0abdb5f849072d51ad3d73aa506c">INSTALL\_PACKAGE</a>: Install a python package from PyPI, an external data source or KiFS. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#ad712fb6529a1b7f6b29f1f67b7257f85">INSTALL\_REQUIREMENTS</a>: Install packages from a requirements file. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#aa66e0ed7ec2633c9fa618fb240b8317c">UNINSTALL\_PACKAGE</a>: Uninstall a python package. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a7ca63a161043526c62b1b07ab1234e8a">UNINSTALL\_REQUIREMENTS</a>: Uninstall packages from a requirements file. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a22b23669284563a873d21154b79455b7">RESET</a>: Uninstalls all packages in the environment and resets it to the original state at time of creation. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a4d2f36910e7ceace605e9f4e017f3158">REBUILD</a>: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies. </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramname">\_value</td>
                <td>The value of the modification, depending on <span className="em">action</span> . For example, if <span className="em">action</span> is <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#af32a0abdb5f849072d51ad3d73aa506c">INSTALL\_PACKAGE</a>, this would be the python package name. If <span className="em">action</span> is <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#ad712fb6529a1b7f6b29f1f67b7257f85">INSTALL\_REQUIREMENTS</a>, this would be the path of a requirements file from which to install packages. If an external data source is specified in <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#a69f4f87ceb09b180dfc1a82a81e01bac">DATASOURCE\_NAME</a>, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in <a href="/content/tools/kifs/" target="_top">KiFS</a>.</td>
              </tr>

              <tr>
                <td className="paramname">options</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#a69f4f87ceb09b180dfc1a82a81e01bac">DATASOURCE\_NAME</a>: Name of an existing external data source from which packages specified in <span className="em">\_value</span> can be loaded. </li>
                  </ul>

                  The default value is an empty Dictionary.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source#l00223">223</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">kinetica.AlterEnvironmentRequest.AlterEnvironmentRequest </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/cs/classkinetica_1_1AlterEnvironmentRequest" title="A set of parameters for Kinetica.alterEnvironment.">AlterEnvironmentRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/Kinetica_2Protocol_2AlterEnvironment_8cs_source#l00143">143</a> of file <a className="el" href="/content/api/cs/Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">kinetica.AlterEnvironmentRequest.AlterEnvironmentRequest </td>
                  <td>(</td>
                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">environment\_name</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">action</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">\_value</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">IDictionary\< string, string ></td>
                  <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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/cs/classkinetica_1_1AlterEnvironmentRequest" title="A set of parameters for Kinetica.alterEnvironment.">AlterEnvironmentRequest</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="paramname">environment\_name</td>
                <td>Name of the environment to be altered. </td>
              </tr>

              <tr>
                <td className="paramname">action</td>

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

                  <ul>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#af32a0abdb5f849072d51ad3d73aa506c">INSTALL\_PACKAGE</a>: Install a python package from PyPI, an external data source or KiFS. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#ad712fb6529a1b7f6b29f1f67b7257f85">INSTALL\_REQUIREMENTS</a>: Install packages from a requirements file. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#aa66e0ed7ec2633c9fa618fb240b8317c">UNINSTALL\_PACKAGE</a>: Uninstall a python package. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a7ca63a161043526c62b1b07ab1234e8a">UNINSTALL\_REQUIREMENTS</a>: Uninstall packages from a requirements file. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a22b23669284563a873d21154b79455b7">RESET</a>: Uninstalls all packages in the environment and resets it to the original state at time of creation. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a4d2f36910e7ceace605e9f4e017f3158">REBUILD</a>: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies. </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramname">\_value</td>
                <td>The value of the modification, depending on <span className="em">action</span> . For example, if <span className="em">action</span> is <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#af32a0abdb5f849072d51ad3d73aa506c">INSTALL\_PACKAGE</a>, this would be the python package name. If <span className="em">action</span> is <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#ad712fb6529a1b7f6b29f1f67b7257f85">INSTALL\_REQUIREMENTS</a>, this would be the path of a requirements file from which to install packages. If an external data source is specified in <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#a69f4f87ceb09b180dfc1a82a81e01bac">DATASOURCE\_NAME</a>, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in <a href="/content/tools/kifs/" target="_top">KiFS</a>.</td>
              </tr>

              <tr>
                <td className="paramname">options</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#a69f4f87ceb09b180dfc1a82a81e01bac">DATASOURCE\_NAME</a>: Name of an existing external data source from which packages specified in <span className="em">\_value</span> can be loaded. </li>
                  </ul>

                  The default value is an empty Dictionary.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cs/Kinetica_2Protocol_2AlterEnvironment_8cs_source#l00223">223</a> of file <a className="el" href="/content/api/cs/Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Property Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a569b5750c387f0aa9d8ac3716c3caecf">◆ </a></span>\_value</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">string kinetica.AlterEnvironmentRequest.\_value</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel get">get</span><span className="mlabel set">set</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The value of the modification, depending on <a className="el" href="#a30c0b8980635eccdebd1b4255f67465c" title="Modification operation to be applied.">AlterEnvironmentRequest.action</a>. </p>
        <p>For example, if <a className="el" href="#a30c0b8980635eccdebd1b4255f67465c" title="Modification operation to be applied.">AlterEnvironmentRequest.action</a> is <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#af32a0abdb5f849072d51ad3d73aa506c">INSTALL\_PACKAGE</a>, this would be the python package name.</p>
        <p>If <a className="el" href="#a30c0b8980635eccdebd1b4255f67465c" title="Modification operation to be applied.">AlterEnvironmentRequest.action</a> is <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#ad712fb6529a1b7f6b29f1f67b7257f85">INSTALL\_REQUIREMENTS</a>, this would be the path of a requirements file from which to install packages.</p>
        <p>If an external data source is specified in <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#a69f4f87ceb09b180dfc1a82a81e01bac">DATASOURCE\_NAME</a>, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in <a href="/content/tools/kifs/" target="_top">KiFS</a>.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source#l00124">124</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a30c0b8980635eccdebd1b4255f67465c">◆ </a></span>action</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">string kinetica.AlterEnvironmentRequest.action</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel get">get</span><span className="mlabel set">set</span></span> </td>
          </tr>
        </table>
      </div>

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

        <ul>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#af32a0abdb5f849072d51ad3d73aa506c">INSTALL\_PACKAGE</a>: Install a python package from PyPI, an external data source or KiFS. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#ad712fb6529a1b7f6b29f1f67b7257f85">INSTALL\_REQUIREMENTS</a>: Install packages from a requirements file. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#aa66e0ed7ec2633c9fa618fb240b8317c">UNINSTALL\_PACKAGE</a>: Uninstall a python package. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a7ca63a161043526c62b1b07ab1234e8a">UNINSTALL\_REQUIREMENTS</a>: Uninstall packages from a requirements file. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a22b23669284563a873d21154b79455b7">RESET</a>: Uninstalls all packages in the environment and resets it to the original state at time of creation. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a4d2f36910e7ceace605e9f4e017f3158">REBUILD</a>: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source#l00106">106</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a6607081627072f523c293facdfdf2988">◆ </a></span>environment\_name</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">string kinetica.AlterEnvironmentRequest.environment\_name</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel get">get</span><span className="mlabel set">set</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the environment to be altered. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source#l00058">58</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">IDictionary\< string, string > kinetica.AlterEnvironmentRequest.options = new Dictionary\<string, string>()</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel get">get</span><span className="mlabel set">set</span></span> </td>
          </tr>
        </table>
      </div>

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

        <ul>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#a69f4f87ceb09b180dfc1a82a81e01bac">DATASOURCE\_NAME</a>: Name of an existing external data source from which packages specified in <a className="el" href="#a569b5750c387f0aa9d8ac3716c3caecf" title="The value of the modification, depending on AlterEnvironmentRequest.action.">AlterEnvironmentRequest.\_value</a> can be loaded. </li>
        </ul>

        <p>The default value is an empty Dictionary.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source#l00139">139</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this class was generated from the following files:

    <ul>
      <li>\_build/public-os\_ubuntu24.04-arch\_amd64-cc\_gcc\_13.3.0/install/Kinetica/Protocol/<a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a></li>
      <li>Kinetica/Protocol/<a className="el" href="/content/api/cs/Kinetica_2Protocol_2AlterEnvironment_8cs_source">AlterEnvironment.cs</a></li>
    </ul>
  </div>
</div>
