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

# showEnvironment

<div className="kinetica-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="showEnvironment(com.gpudb.protocol.ShowEnvironmentRequest)">
        <h3>showEnvironment</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentResponse" title="class in com.gpudb.protocol">ShowEnvironmentResponse</a></span> <span className="element-name">showEnvironment</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest" title="class in com.gpudb.protocol">ShowEnvironmentRequest</a> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">Shows information about a specified <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF) environment or all environments. Returns detailed information about existing environments.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="showEnvironment(java.lang.String,java.util.Map)">
        <h3>showEnvironment</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentResponse" title="class in com.gpudb.protocol">ShowEnvironmentResponse</a></span> <span className="element-name">showEnvironment</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> environmentName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">Shows information about a specified <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF) environment or all environments. Returns detailed information about existing environments.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>environmentName</code> - Name of the environment on which to retrieve information. The name must refer to a currently existing environment. If '\*' or an empty value is specified, information about all environments will be returned. The default value is ''.</div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li>
                <a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#NO_ERROR_IF_NOT_EXISTS"><code>NO\_ERROR\_IF\_NOT\_EXISTS</code></a>: If <a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#TRUE"><code>TRUE</code></a> and if the environment specified in <code> environmentName</code> does not exist, no error is returned. If <a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#FALSE"><code>FALSE</code></a> and if the environment specified in <code>environmentName</code> does not exist, then an error is returned. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#SHOW_NAMES_ONLY"><code>SHOW\_NAMES\_ONLY</code></a>: If <a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#TRUE"><code>TRUE</code></a> only return the names of the installed environments and omit package listing. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>
            </ul>

            The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/ShowEnvironmentResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>