com.splunk
Class FiredAlert

java.lang.Object
  extended by com.splunk.Resource
      extended by com.splunk.Entity
          extended by com.splunk.FiredAlert
All Implemented Interfaces:
java.util.Map<java.lang.String,java.lang.Object>

public class FiredAlert
extends Entity

The FiredAlert class represents a fired alert.


Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Field Summary
 
Fields inherited from class com.splunk.Entity
content, toUpdate
 
Fields inherited from class com.splunk.Resource
actions, path, refreshArgs, service, title
 
Method Summary
 java.lang.String[] getAction()
          Returns this alert's actions (such as notifying by email, running a script, adding to RSS, tracking in Alert Manager, and enabling summary indexing).
 java.lang.String getAlertType()
          Returns this alert's type.
 java.lang.String getExpirationTime()
          Returns the rendered expiration time for this alert.
 java.util.Date getParsedExpirationTime()
          Returns the rendered expiration time for this alert, parsed as a Date object.
 java.lang.String getSavedSearchName()
          Returns the saved search for this alert.
 int getSeverity()
          Returns this alert's severity on a scale of 1 to 10, with 1 being the highest severity.
 java.lang.String getSid()
          Returns this alert's search ID (SID).
 int getTriggeredAlertCount()
          Returns the count of triggered alerts.
 java.util.Date getTriggerTime()
          Returns the time this alert was triggered.
 java.util.Date getTriggerTimeRendered()
          Returns this alert's rendered trigger time.
 boolean isDigestMode()
          Indicates whether the result is a set of events (digest) or a single event (per result).
 
Methods inherited from class com.splunk.Entity
actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, getContent, getMetadata, isDisabled, isEmpty, isNameChangeAllowed, keySet, put, putAll, refresh, remove, remove, size, update, update, validate, values
 
Methods inherited from class com.splunk.Resource
getName, getPath, getService, getTitle, invalidate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Method Detail

getAction

public java.lang.String[] getAction()
Returns this alert's actions (such as notifying by email, running a script, adding to RSS, tracking in Alert Manager, and enabling summary indexing).

Returns:
The alert actions, or null if not available.

getAlertType

public java.lang.String getAlertType()
Returns this alert's type.

Returns:
The alert type, or null if not available.

getExpirationTime

public java.lang.String getExpirationTime()
Returns the rendered expiration time for this alert. This method is available in Splunk 4.3 and later.

Returns:
This alert's rendered expiration time, or null if not available.

getParsedExpirationTime

public java.util.Date getParsedExpirationTime()
Returns the rendered expiration time for this alert, parsed as a Date object. This method is available in Splunk 4.3 and later.

Returns:
This alert's rendered expiration time, or null if not available.

getSavedSearchName

public java.lang.String getSavedSearchName()
Returns the saved search for this alert.

Returns:
The saved search name, or null if not available.

getSeverity

public int getSeverity()
Returns this alert's severity on a scale of 1 to 10, with 1 being the highest severity.

Returns:
This alert's severity, or -1 if the value is not specified.

getSid

public java.lang.String getSid()
Returns this alert's search ID (SID).

Returns:
This alert's SID, or null if not available.

getTriggeredAlertCount

public int getTriggeredAlertCount()
Returns the count of triggered alerts. This method is available in Splunk 4.3 and later.

Returns:
The number of triggered alerts, or -1 if not specified.

getTriggerTime

public java.util.Date getTriggerTime()
Returns the time this alert was triggered.

Returns:
This alert's trigger time, or null if not available.

getTriggerTimeRendered

public java.util.Date getTriggerTimeRendered()
Returns this alert's rendered trigger time. This method is available in Splunk 4.3 and later.

Returns:
This alert's trigger time, or null if not available.

isDigestMode

public boolean isDigestMode()
Indicates whether the result is a set of events (digest) or a single event (per result). This method is available in Splunk 4.3 and later.

Returns:
true if the result is a digest, false if per result.