A set of parameters for Kinetica.showEnvironment. More...
Inheritance diagram for kinetica.ShowEnvironmentRequest:
Collaboration diagram for kinetica.ShowEnvironmentRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| ShowEnvironmentRequest () | |
| Constructs a ShowEnvironmentRequest object with default parameters. More... | |
| ShowEnvironmentRequest (string environment_name=null, IDictionary< string, string > options=null) | |
| Constructs a ShowEnvironmentRequest object with the specified parameters. More... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| string | environment_name = "" [get, set] |
| Name of the environment on which to retrieve information. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
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. More... | |
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 19 of file ShowEnvironment.cs.
Constructor & Destructor Documentation
◆ ShowEnvironmentRequest() [1/2]
|
inline |
Constructs a ShowEnvironmentRequest object with default parameters.
Definition at line 84 of file ShowEnvironment.cs.
◆ ShowEnvironmentRequest() [2/2]
|
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. The default value is an empty Dictionary.
Definition at line 121 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 52 of file ShowEnvironment.cs.
◆ options
|
getset |
Optional 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.
The default value is an empty Dictionary.
Definition at line 80 of file ShowEnvironment.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/ShowEnvironment.cs
