kinetica.ShowProcRequest Class Reference
A set of parameters for Kinetica.showProc. More...
Inheritance diagram for kinetica.ShowProcRequest:
Collaboration diagram for kinetica.ShowProcRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| ShowProcRequest () | |
| Constructs a ShowProcRequest object with default parameters. More... | |
| ShowProcRequest (string proc_name=null, IDictionary< string, string > options=null) | |
| Constructs a ShowProcRequest object with the specified parameters. More... | |
| ShowProcRequest () | |
| Constructs a ShowProcRequest object with default parameters. More... | |
| ShowProcRequest (string proc_name=null, IDictionary< string, string > options=null) | |
| Constructs a ShowProcRequest 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... | |
| 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 | proc_name = "" [get, set] |
| Name of the proc to show information about. 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... | |
| Properties inherited from Avro.Specific.ISpecificRecord | |
| Schema | Schema [get] |
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... | |
| 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.showProc.
Shows information about a proc.
Definition at line 15 of file ShowProc.cs.
Constructor & Destructor Documentation
◆ ShowProcRequest() [1/4]
|
inline |
Constructs a ShowProcRequest object with default parameters.
Definition at line 74 of file ShowProc.cs.
◆ ShowProcRequest() [2/4]
|
inline |
Constructs a ShowProcRequest object with the specified parameters.
- Parameters
-
proc_name Name of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. The default value is ''. options Optional parameters. The default value is an empty Dictionary.
Definition at line 106 of file ShowProc.cs.
◆ ShowProcRequest() [3/4]
|
inline |
Constructs a ShowProcRequest object with default parameters.
Definition at line 74 of file ShowProc.cs.
◆ ShowProcRequest() [4/4]
|
inline |
Constructs a ShowProcRequest object with the specified parameters.
- Parameters
-
proc_name Name of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. The default value is ''. options Optional parameters. The default value is an empty Dictionary.
Definition at line 106 of file ShowProc.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- INCLUDE_FILES: If set to TRUE, the files that make up the proc will be returned. If set to FALSE, the files will not be returned. Supported values: The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 70 of file ShowProc.cs.
◆ proc_name
|
getset |
Name of the proc to show information about.
If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. The default value is ''.
Definition at line 45 of file ShowProc.cs.
The documentation for this class was generated from the following file:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowProc.cs
