kinetica.KillProcRequest Class Reference

A set of parameters for Kinetica.killProc(string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.KillProcRequest:

Collaboration diagram for kinetica.KillProcRequest:

Classes
struct	Options
	Optional parameters. 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 = "" [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(string,IDictionary{string, string}).

Kills a running proc instance.

Definition at line 18 of file KillProc.cs.

Constructor & Destructor Documentation

kinetica.KillProcRequest.KillProcRequest ( )

inline

Constructs a KillProcRequest object with default parameters.

Definition at line 77 of file KillProc.cs.

kinetica.KillProcRequest.KillProcRequest ( string  run_id = null, IDictionary< string, string >  options = null  )

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 is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to /execute/proc. If is not specified, kill the proc instance(s) where a matching run tag was provided to /execute/proc. The default value is ''. The default value is an empty Dictionary.

Definition at line 102 of file KillProc.cs.

Property Documentation

IDictionary<string, string> kinetica.KillProcRequest.options = ""

getset

Optional parameters.

• RUN_TAG: If is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to /execute/proc. If is not specified, kill the proc instance(s) where a matching run tag was provided to /execute/proc. The default value is ''.

The default value is an empty Dictionary.

Definition at line 72 of file KillProc.cs.

string kinetica.KillProcRequest.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 56 of file KillProc.cs.

---

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

• Kinetica/Protocol/KillProc.cs