Kinetica C# API  Version 6.2.0.1
kinetica.AdminShowAlertsRequest Class Reference

A set of parameters for Kinetica.adminShowAlerts(int,IDictionary<string, string>). More...

+ Inheritance diagram for kinetica.AdminShowAlertsRequest:
+ Collaboration diagram for kinetica.AdminShowAlertsRequest:

Public Member Functions

 AdminShowAlertsRequest ()
 Constructs an AdminShowAlertsRequest object with default parameters. More...
 
 AdminShowAlertsRequest (int num_alerts, IDictionary< string, string > options=null)
 Constructs an AdminShowAlertsRequest 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

int num_alerts [get, set]
 Number of most recent alerts to request. 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.adminShowAlerts(int,IDictionary<string, string>).


Retrieves a list of the most recent alerts generated. The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest

Definition at line 20 of file AdminShowAlerts.cs.

Constructor & Destructor Documentation

◆ AdminShowAlertsRequest() [1/2]

kinetica.AdminShowAlertsRequest.AdminShowAlertsRequest ( )
inline

Constructs an AdminShowAlertsRequest object with default parameters.

Definition at line 36 of file AdminShowAlerts.cs.

◆ AdminShowAlertsRequest() [2/2]

kinetica.AdminShowAlertsRequest.AdminShowAlertsRequest ( int  num_alerts,
IDictionary< string, string >  options = null 
)
inline

Constructs an AdminShowAlertsRequest object with the specified parameters.

Parameters
num_alertsNumber of most recent alerts to request. The response will return alerts, or less if there are less in the system. A value of 0 returns all stored alerts.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 49 of file AdminShowAlerts.cs.

Property Documentation

◆ num_alerts

int kinetica.AdminShowAlertsRequest.num_alerts
getset

Number of most recent alerts to request.

The response will return alerts, or less if there are less in the system. A value of 0 returns all stored alerts.

Definition at line 27 of file AdminShowAlerts.cs.

◆ options

IDictionary<string, string> kinetica.AdminShowAlertsRequest.options
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 31 of file AdminShowAlerts.cs.


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