Skip to main content

A set of parameters for Kinetica.showProcStatus. More…

Inheritance diagram for kinetica.ShowProcStatusRequest:
[legend]
Collaboration diagram for kinetica.ShowProcStatusRequest:
[legend]

​
Classes

struct  Options
 A set of string constants for the parameter ShowProcStatusRequest.options. More…
 

​
Public Member Functions

 ShowProcStatusRequest ()
 Constructs a ShowProcStatusRequest object with default parameters.
 
 ShowProcStatusRequest (string run_id=null, IDictionary< string, string > options=null)
 Constructs a ShowProcStatusRequest object with the specified parameters.
 
 ShowProcStatusRequest ()
 Constructs a ShowProcStatusRequest object with default parameters.
 
 ShowProcStatusRequest (string run_id=null, IDictionary< string, string > options=null)
 Constructs a ShowProcStatusRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

​
Properties

string run_id = "" [get, set]
 The run ID of a specific proc instance for which the status will be returned.
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
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.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of parameters for Kinetica.showProcStatus.

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

Definition at line 19 of file ShowProcStatus.cs.

​
Constructor & Destructor Documentation

​
◆ ShowProcStatusRequest() [1/4]

kinetica.ShowProcStatusRequest.ShowProcStatusRequest ()
 inline

Constructs a ShowProcStatusRequest object with default parameters.

Definition at line 126 of file ShowProcStatus.cs.

​
◆ ShowProcStatusRequest() [2/4]

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

Constructs a ShowProcStatusRequest object with the specified parameters.

Parameters
run_idThe 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 ”.
optionsOptional 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:The default value is FALSE.
  • RUN_TAG: If run_id is specified, return the status for a 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, return statuses for all proc instances where a matching run tag was provided to Kinetica.executeProc. The default value is ”.
The default value is an empty Dictionary.

Definition at line 180 of file ShowProcStatus.cs.

​
◆ ShowProcStatusRequest() [3/4]

kinetica.ShowProcStatusRequest.ShowProcStatusRequest ()
 inline

Constructs a ShowProcStatusRequest object with default parameters.

Definition at line 126 of file ShowProcStatus.cs.

​
◆ ShowProcStatusRequest() [4/4]

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

Constructs a ShowProcStatusRequest object with the specified parameters.

Parameters
run_idThe 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 ”.
optionsOptional 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:The default value is FALSE.
  • RUN_TAG: If run_id is specified, return the status for a 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, return statuses for all proc instances where a matching run tag was provided to Kinetica.executeProc. The default value is ”.
The default value is an empty Dictionary.

Definition at line 180 of file ShowProcStatus.cs.

​
Property Documentation

​
◆ options

IDictionary< string, string > kinetica.ShowProcStatusRequest.options = new Dictionary<string, string>()
 getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 122 of file ShowProcStatus.cs.

​
◆ run_id

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 75 of file ShowProcStatus.cs.

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