kinetica.ShowProcStatusRequest Class Reference

A set of parameters for /show/proc/status. More...

Inheritance diagram for kinetica.ShowProcStatusRequest:

Collaboration diagram for kinetica.ShowProcStatusRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	ShowProcStatusRequest ()
	Constructs a ShowProcStatusRequest object with default parameters. More...
	ShowProcStatusRequest (string run_id=null, IDictionary< string, string > options=null)
	Constructs a ShowProcStatusRequest 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 specific running or completed proc instance for which the status will be returned. 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 /show/proc/status.

Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from /execute/proc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).

Definition at line 20 of file ShowProcStatus.cs.

Constructor & Destructor Documentation

kinetica.ShowProcStatusRequest.ShowProcStatusRequest ( )

inline

Constructs a ShowProcStatusRequest object with default parameters.

Definition at line 75 of file ShowProcStatus.cs.

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

inline

Constructs a ShowProcStatusRequest object with the specified parameters.

Parameters

run_id	The run ID of a specific running or completed proc instance for which the status will be returned. If the run ID is not found, nothing will be returned. If not specified, the statuses of all running and completed proc instances will be returned.
options	Optional parameters. clear_complete If set to true, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Values: true, false.

Definition at line 98 of file ShowProcStatus.cs.

Property Documentation

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

getset

Optional parameters.

• clear_complete If set to true, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Values: true, false.

Definition at line 70 of file ShowProcStatus.cs.

string kinetica.ShowProcStatusRequest.run_id

getset

The run ID of a specific running or completed proc instance for which the status will be returned.

If the run ID is not found, nothing will be returned. If not specified, the statuses of all running and completed proc instances will be returned.

Definition at line 56 of file ShowProcStatus.cs.

---

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

• Kinetica/Protocol/ShowProcStatus.cs