kinetica.ShowProcStatusRequest.Options Struct Reference

Optional parameters. More...

Public Attributes
const string	CLEAR_COMPLETE = "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. More...
const string	TRUE = "true"
const string	FALSE = "false"
const string	RUN_TAG = "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(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}). More...

Detailed Description

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. A set of string constants for the parameter options.

Definition at line 63 of file ShowProcStatus.cs.

Member Data Documentation

const string kinetica.ShowProcStatusRequest.Options.CLEAR_COMPLETE = "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.

Definition at line 83 of file ShowProcStatus.cs.

const string kinetica.ShowProcStatusRequest.Options.FALSE = "false"

Definition at line 85 of file ShowProcStatus.cs.

const string kinetica.ShowProcStatusRequest.Options.RUN_TAG = "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(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}).

If run_id is not specified, return statuses for all proc instances where a matching run tag was provided to Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}). The default value is ''.

Definition at line 96 of file ShowProcStatus.cs.

const string kinetica.ShowProcStatusRequest.Options.TRUE = "true"

Definition at line 84 of file ShowProcStatus.cs.

---

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

• Kinetica/Protocol/ShowProcStatus.cs