A set of parameters for Kinetica.showEnvironment. More…
Inheritance diagram for kinetica.ShowEnvironmentRequest:
[legend]
Collaboration diagram for kinetica.ShowEnvironmentRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter ShowEnvironmentRequest.options. More… | |
Public Member Functions | |
| ShowEnvironmentRequest () | |
| Constructs a ShowEnvironmentRequest object with default parameters. | |
| ShowEnvironmentRequest (string environment_name=null, IDictionary< string, string > options=null) | |
| Constructs a ShowEnvironmentRequest object with the specified parameters. | |
| ShowEnvironmentRequest () | |
| Constructs a ShowEnvironmentRequest object with default parameters. | |
| ShowEnvironmentRequest (string environment_name=null, IDictionary< string, string > options=null) | |
| Constructs a ShowEnvironmentRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | environment_name = "" [get, set] |
| Name of the environment on which to retrieve information. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
Detailed Description
A set of parameters for Kinetica.showEnvironment.
Shows information about a specified user-defined function (UDF) environment or all environments. Returns detailed information about existing environments.
Definition at line 18 of file ShowEnvironment.cs.
Constructor & Destructor Documentation
◆ ShowEnvironmentRequest() [1/4]
| inline |
Constructs a ShowEnvironmentRequest object with default parameters.
Definition at line 155 of file ShowEnvironment.cs.
◆ ShowEnvironmentRequest() [2/4]
| inline |
Constructs a ShowEnvironmentRequest object with the specified parameters.
Parameters
| environment_name | 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 ”. |
| options | Optional parameters.
|
Definition at line 221 of file ShowEnvironment.cs.
◆ ShowEnvironmentRequest() [3/4]
| inline |
Constructs a ShowEnvironmentRequest object with default parameters.
Definition at line 155 of file ShowEnvironment.cs.
◆ ShowEnvironmentRequest() [4/4]
| inline |
Constructs a ShowEnvironmentRequest object with the specified parameters.
Parameters
| environment_name | 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 ”. |
| options | Optional parameters.
|
Definition at line 221 of file ShowEnvironment.cs.
Property Documentation
◆ environment_name
| getset |
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 ”.
Definition at line 90 of file ShowEnvironment.cs.
◆ options
| getset |
Optional parameters.
- NO_ERROR_IF_NOT_EXISTS: If TRUE and if the environment specified in ShowEnvironmentRequest.environment_name does not exist, no error is returned. If FALSE and if the environment specified in ShowEnvironmentRequest.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.
Definition at line 151 of file ShowEnvironment.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowEnvironment.cs
- Kinetica/Protocol/ShowEnvironment.cs