public interface AlertRule
Modifier and Type | Interface and Description |
---|---|
static class |
AlertRule.Type
Gets the type of alert, currently 2 types are supported: Cron Alert and Query Alert
|
Modifier and Type | Method and Description |
---|---|
java.util.List<AlertRuleAction> |
getActions()
This gets the live list of actions, so you could remove or rearrange these, and the changes will be saved if you save the Alert.
|
QueryConfig |
getAlertQueryConfig()
Gets the value of the alertQueryConfig property.
|
AlertRule.Type |
getAlertType()
Gets the value of alertType property
|
java.util.Calendar |
getCreated()
Gets the value of the created property.
|
java.lang.String |
getCronString()
Gets the value of the cronString property.
|
java.lang.String |
getDescription()
Gets the value of the description property.
|
java.lang.Long |
getId()
Gets the value of the id property.
|
java.util.Calendar |
getLastUpdated()
Gets the value of the lastUpdated property.
|
java.lang.String |
getMessageTemplate()
Gets the value of the messageTemplate property.
|
java.lang.String |
getName()
Gets the value of the name property.
|
java.lang.String |
getOwner()
Gets the value of the owner property.
|
java.lang.Integer |
getPersistedVersion()
Gets the value of the persistedVersion property.
|
java.lang.Integer |
getQuiescence()
Gets the value of the quiescence property.
|
java.lang.Integer |
getSeverity()
Gets the value of the severity property.
|
java.lang.String |
getStatusMessage()
Gets the value of the statusMessage property.
|
boolean |
isEnabled()
Gets the value of the enabled property.
|
boolean |
isValid()
Gets the value of the status property.
|
ExecuteJavaAction |
newExecuteJavaAction()
Creates a new ExecuteJavaAction and adds it to the end of the list of Actions
|
ExecuteOSCommandAction |
newExecuteOSCommandAction()
Creates a new ExecuteOSCommandAction and adds it to the end of the list of Actions
|
IssueDeleteQueryAction |
newIssueDeleteQueryAction()
Creates a new IssueDeleteQueryAction and adds it to the end of the list of Actions
|
LVPublishAlertAction |
newLVPublishAlertAction()
Creates a new LVPublishAlertAction and adds it to the end of the list of Actions
|
PublishAlertAction |
newPublishAlertAction()
Creates a new PublishAlertAction and adds it to the end of the list of Actions
|
SendEmailAction |
newSendEmailAction()
Creates a new SendEmailAction and adds it to the end of the list of Actions
|
SendTupleAction |
newSendTupleAction()
Creates a new SendTupleAction and adds it to the end of the list of Actions
|
void |
setAlertQueryConfig(QueryConfig queryConfig)
Sets the value of the alertQueryConfig property.
|
void |
setAlertType(AlertRule.Type alertType)
Sets the value of alertTypeproperty
|
void |
setCronString(java.lang.String value)
Sets the value of the cronString property which is a cron expression.
|
void |
setDescription(java.lang.String value)
Sets the value of the description property.
|
void |
setEnabled(boolean value)
Sets the value of the enabled property.
|
void |
setIsValid(boolean isValid)
Sets the value of the status property.
|
void |
setMessageTemplate(java.lang.String value)
Sets the value of the messageTemplate property.
|
void |
setName(java.lang.String value)
Sets the value of the name property.
|
void |
setOwner(java.lang.String value)
Sets the value of the owner property.
|
void |
setPersistedVersion(java.lang.Integer value)
Sets the value of the persistedVersion property.
|
void |
setQuiescence(int value)
Sets the value of the quiescence property.
|
void |
setSeverity(int value)
Sets the value of the severity property.
|
void |
setStatusMessage(java.lang.String value)
Sets the value of the statusMessage property.
|
java.lang.String getStatusMessage()
String
void setStatusMessage(java.lang.String value)
value
- allowed object is String
java.lang.String getCronString()
void setCronString(java.lang.String value)
Expressions Allowed Fields and Values 1) Seconds: 0-59 or Allowed special characters(, - * /) 2) Minutes: 0-59 or Allowed special characters(, - * /) 3) Hours: 0-23 or Allowed special characters(, - * /) 4) Day of month: 1-31 or Allowed special characters(, - * ? / L W C) 5) Month: 0-11 or JAN-DEC or Allowed special characters(, - * /) 6) Day of week: 1-7 or SUN-SAT or Allowed special characters(, - * ? / L C #) 7) Year: empty or 1970-2099 or Allowed special characters(, - * /) e.g: 0 15 10 * * ? 2005 Fire the alert at 10:15 AM every day during the year 2005
value
- allowed object is String
void setAlertType(AlertRule.Type alertType)
value
- allowed object is SAlertRule.Type
AlertRule.Type getAlertType()
QueryConfig getAlertQueryConfig()
Query
void setAlertQueryConfig(QueryConfig queryConfig)
queryConfig
- allowed object is QueryConfig
java.lang.String getDescription()
String
void setDescription(java.lang.String value)
value
- allowed object is String
java.lang.String getMessageTemplate()
String
void setMessageTemplate(java.lang.String value)
value
- allowed object is String
java.lang.String getName()
String
void setName(java.lang.String value)
value
- allowed object is String
java.lang.Integer getSeverity()
Integer
void setSeverity(int value)
value
- allowed object is Integer
java.lang.Integer getQuiescence()
void setQuiescence(int value)
value
- boolean isEnabled()
Boolean
void setEnabled(boolean value)
value
- allowed object is Boolean
java.lang.String getOwner()
*
means "all users."String
void setOwner(java.lang.String value)
*
means "all users."
Note that since 2.2.3, if authentication is enabled, the user provided value is ignored and replaced with
the currently authenticated user.value
- allowed object is String
java.util.Calendar getCreated()
Calendar
java.util.Calendar getLastUpdated()
Calendar
java.lang.Long getId()
Long
boolean isValid()
void setIsValid(boolean isValid)
isValid
- allowed object is StatusType
java.lang.Integer getPersistedVersion()
Integer
void setPersistedVersion(java.lang.Integer value)
value
- allowed object is Integer
java.util.List<AlertRuleAction> getActions()
ExecuteJavaAction newExecuteJavaAction()
ExecuteOSCommandAction newExecuteOSCommandAction()
IssueDeleteQueryAction newIssueDeleteQueryAction()
PublishAlertAction newPublishAlertAction()
SendEmailAction newSendEmailAction()
SendTupleAction newSendTupleAction()
LVPublishAlertAction newLVPublishAlertAction()