kinetica.ShowProcStatusRequest Class Reference

A set of parameters for Kinetica.showProcStatus(string,IDictionary{string, string}). 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 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 Kinetica.showProcStatus(string,IDictionary{string, string}).

Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string})) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).

Definition at line 23 of file ShowProcStatus.cs.

Constructor & Destructor Documentation

kinetica.ShowProcStatusRequest.ShowProcStatusRequest ( )

inline

Constructs a ShowProcStatusRequest object with default parameters.

Definition at line 147 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 proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned. The default value is ''.

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. Supported values: TRUE FALSE The default value is FALSE. RUN_TAG: If is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to /execute/proc. If is not specified, return statuses for all proc instances where a matching run tag was provided to /execute/proc. The default value is ''. The default value is an empty Dictionary.

Definition at line 193 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. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• RUN_TAG: If is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to /execute/proc. If is not specified, return statuses for all proc instances where a matching run tag was provided to /execute/proc. The default value is ''.

The default value is an empty Dictionary.

Definition at line 142 of file ShowProcStatus.cs.

string kinetica.ShowProcStatusRequest.run_id

getset

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

If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned. The default value is ''.

Definition at line 105 of file ShowProcStatus.cs.

---

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

• Kinetica/Protocol/ShowProcStatus.cs