Kinetica   C#   API  Version 7.2.3.0
kinetica.AdminSendAlertRequest Class Reference

A set of parameters for Kinetica.adminSendAlert. More...

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

Classes

struct  LogLevel
 A set of string constants for the parameter log_level. More...
 

Public Member Functions

 AdminSendAlertRequest ()
 Constructs an AdminSendAlertRequest object with default parameters. More...
 
 AdminSendAlertRequest (string message, string label, string log_level, IDictionary< string, string > options=null)
 Constructs an AdminSendAlertRequest 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 message = "" [get, set]
 Alert message body. More...
 
string label = "" [get, set]
 Label to add to alert message. More...
 
string log_level [get, set]
 Alert message logging criteria. More...
 
IDictionary< string, string > options = new Dictionary<string, string>() [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.adminSendAlert.

Sends a user generated alert to the monitoring system.

Definition at line 16 of file AdminSendAlert.cs.

Constructor & Destructor Documentation

◆ AdminSendAlertRequest() [1/2]

kinetica.AdminSendAlertRequest.AdminSendAlertRequest ( )
inline

Constructs an AdminSendAlertRequest object with default parameters.

Definition at line 66 of file AdminSendAlert.cs.

◆ AdminSendAlertRequest() [2/2]

kinetica.AdminSendAlertRequest.AdminSendAlertRequest ( string  message,
string  label,
string  log_level,
IDictionary< string, string >  options = null 
)
inline

Constructs an AdminSendAlertRequest object with the specified parameters.

Parameters
messageAlert message body. The default value is ''.
labelLabel to add to alert message. The default value is ''.
log_levelAlert message logging criteria. Supported values:
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 96 of file AdminSendAlert.cs.

Property Documentation

◆ label

string kinetica.AdminSendAlertRequest.label = ""
getset

Label to add to alert message.

The default value is ''.

Definition at line 36 of file AdminSendAlert.cs.

◆ log_level

string kinetica.AdminSendAlertRequest.log_level
getset

Alert message logging criteria.

Supported values:

Definition at line 57 of file AdminSendAlert.cs.

◆ message

string kinetica.AdminSendAlertRequest.message = ""
getset

Alert message body.

The default value is ''.

Definition at line 32 of file AdminSendAlert.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 62 of file AdminSendAlert.cs.


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