Skip to main content

​
◆ showEnvironment() [1/2]

ShowEnvironmentResponse kinetica.Kinetica.showEnvironment (ShowEnvironmentRequestrequest_)
 inline

Shows information about a specified user-defined function (UDF) environment or all environments.Returns detailed information about existing environments.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 59998 of file KineticaFunctions.cs.

​
◆ showEnvironment() [2/2]

ShowEnvironmentResponse kinetica.Kinetica.showEnvironment (stringenvironment_name = "",
IDictionary< string, string >options = null )
 inline

Shows information about a specified user-defined function (UDF) environment or all environments.Returns detailed information about existing environments.

Parameters
environment_nameName 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 ”.
optionsOptional parameters.
  • NO_ERROR_IF_NOT_EXISTS: If TRUE and if the environment specified in environment_name does not exist, no error is returned. If FALSE and if the environment specified in environment_name does not exist, then an error is returned. Supported values:The default value is FALSE.
  • SHOW_NAMES_ONLY: If TRUE only return the names of the installed environments and omit package listing. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 60092 of file KineticaFunctions.cs.

​
◆ ShowEnvironmentAsync() [1/2]

async System.Threading.Tasks.Task< ShowEnvironmentResponse > kinetica.Kinetica.ShowEnvironmentAsync (ShowEnvironmentRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Shows information about a specified user-defined function (UDF) environment or all environments.Returns detailed information about existing environments.

(async)

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 60016 of file KineticaFunctions.cs.

​
◆ ShowEnvironmentAsync() [2/2]

async System.Threading.Tasks.Task< ShowEnvironmentResponse > kinetica.Kinetica.ShowEnvironmentAsync (stringenvironment_name = "",
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Shows information about a specified user-defined function (UDF) environment or all environments.Returns detailed information about existing environments.

(async)

Parameters
environment_nameName 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 ”.
optionsOptional parameters.
  • NO_ERROR_IF_NOT_EXISTS: If TRUE and if the environment specified in environment_name does not exist, no error is returned. If FALSE and if the environment specified in environment_name does not exist, then an error is returned. Supported values:The default value is FALSE.
  • SHOW_NAMES_ONLY: If TRUE only return the names of the installed environments and omit package listing. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 60168 of file KineticaFunctions.cs.