Kinetica C# API  Version 6.2.0.1
kinetica.ShowProcRequest Class Reference

A set of parameters for Kinetica.showProc(string,IDictionary<string, string>). More...

+ Inheritance diagram for kinetica.ShowProcRequest:
+ Collaboration diagram for kinetica.ShowProcRequest:

Classes

struct  Options
 Optional parameters. 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...
 
- 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 proc_name [get, set]
 Name of the proc to show information about. More...
 
IDictionary< string, string > options = "" [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.showProc(string,IDictionary<string, string>).


Shows information about a proc.

Definition at line 18 of file ShowProc.cs.

Constructor & Destructor Documentation

◆ ShowProcRequest() [1/2]

kinetica.ShowProcRequest.ShowProcRequest ( )
inline

Constructs a ShowProcRequest object with default parameters.

Definition at line 107 of file ShowProc.cs.

◆ ShowProcRequest() [2/2]

kinetica.ShowProcRequest.ShowProcRequest ( string  proc_name = null,
IDictionary< string, string >  options = null 
)
inline

Constructs a ShowProcRequest object with the specified parameters.

Parameters
proc_nameName 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 ''.
optionsOptional 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 141 of file ShowProc.cs.

Property Documentation

◆ options

IDictionary<string, string> kinetica.ShowProcRequest.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 102 of file ShowProc.cs.

◆ proc_name

string kinetica.ShowProcRequest.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 76 of file ShowProc.cs.


The documentation for this class was generated from the following file: