Kinetica   C#   API  Version 7.2.3.0
kinetica.ShowProcStatusRequest.Options Struct Reference

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

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 24 of file ShowProcStatus.cs.

Member Data Documentation

◆ CLEAR_COMPLETE

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:

The default value is FALSE.

Definition at line 41 of file ShowProcStatus.cs.

◆ FALSE

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

Definition at line 44 of file ShowProcStatus.cs.

◆ RUN_TAG

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.

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 ''.

Definition at line 56 of file ShowProcStatus.cs.

◆ TRUE

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

Definition at line 43 of file ShowProcStatus.cs.


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