kinetica.KillProcRequest Class Reference
A set of parameters for Kinetica.killProc. More...
Inheritance diagram for kinetica.KillProcRequest:
Collaboration diagram for kinetica.KillProcRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| KillProcRequest () | |
| Constructs a KillProcRequest object with default parameters. More... | |
| KillProcRequest (string run_id=null, IDictionary< string, string > options=null) | |
| Constructs a KillProcRequest 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 | run_id = "" [get, set] |
| The run ID of a running proc instance. 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.killProc.
Kills a running proc instance.
Definition at line 15 of file KillProc.cs.
Constructor & Destructor Documentation
◆ KillProcRequest() [1/2]
|
inline |
Constructs a KillProcRequest object with default parameters.
Definition at line 103 of file KillProc.cs.
◆ KillProcRequest() [2/2]
|
inline |
Constructs a KillProcRequest object with the specified parameters.
- Parameters
-
run_id The run ID of a running proc instance. If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ''. options Optional parameters. - RUN_TAG: If run_id is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to Kinetica.executeProc. If run_id is not specified, kill the proc instance(s) where a matching run tag was provided to Kinetica.executeProc. The default value is ''.
- CLEAR_EXECUTE_AT_STARTUP: If TRUE, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned from Kinetica.executeProc and can be retrieved using Kinetica.showProc. Supported values: The default value is FALSE.
Definition at line 152 of file KillProc.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- RUN_TAG: If run_id is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to Kinetica.executeProc. If run_id is not specified, kill the proc instance(s) where a matching run tag was provided to Kinetica.executeProc. The default value is ''.
- CLEAR_EXECUTE_AT_STARTUP: If TRUE, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned from Kinetica.executeProc and can be retrieved using Kinetica.showProc. Supported values: The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 99 of file KillProc.cs.
◆ run_id
|
getset |
The run ID of a running proc instance.
If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed. The default value is ''.
Definition at line 59 of file KillProc.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/KillProc.cs
