Dampening (Hawkular Alerts Api 0.6.0.Final API)

java.lang.Object
- org.hawkular.alerts.api.model.dampening.Dampening

```
public class Dampening
extends Object
```
A representation of dampening status.

Author:

Jay Shaughnessy

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Dampening.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`Dampening.Type`

Field Summary

Fields
Modifier and Type Field and Description

protected String dampeningId
A composed key for the dampening

Fields
Modifier and Type	Field and Description
`protected String`	`dampeningId` A composed key for the dampening

Constructor Summary

Constructors
Constructor and Description
`Dampening()`
`Dampening(String triggerId, Mode triggerMode, Dampening.Type type, int evalTrueSetting, int evalTotalSetting, long evalTimeSetting)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSatisfyingEvals(ConditionEval... satisfyingEvals)`
`void`	`addSatisfyingEvals(Set<ConditionEval> satisfyingEvals)`
`boolean`	`equals(Object obj)`
`static Dampening`	`forRelaxedCount(String triggerId, Mode triggerMode, int numTrueEvals, int numTotalEvals)` Fire if we have `numTrueEvals` of the condition set out of `numTotalEvals`.
`static Dampening`	`forRelaxedTime(String triggerId, Mode triggerMode, int numTrueEvals, long evalPeriod)` Fire if we have `numTrueEvals` of the condition set within `evalPeriod`.
`static Dampening`	`forStrict(String triggerId, Mode triggerMode, int numConsecutiveTrueEvals)` Fire if we have `numTrueEvals` consecutive true evaluations of the condition set.
`static Dampening`	`forStrictTime(String triggerId, Mode triggerMode, long evalPeriod)` Fire if we have only true evaluations of the condition set for at least `evalPeriod`.
`static Dampening`	`forStrictTimeout(String triggerId, Mode triggerMode, long evalPeriod)` Fire if we have only true evaluations of the condition set for `evalPeriod`.
`Map<Integer,ConditionEval>`	`getCurrentEvals()`
`String`	`getDampeningId()`
`long`	`getEvalTimeSetting()`
`int`	`getEvalTotalSetting()`
`int`	`getEvalTrueSetting()`
`int`	`getNumEvals()`
`int`	`getNumTrueEvals()`
`List<Set<ConditionEval>>`	`getSatisfyingEvals()`
`String`	`getTenantId()`
`String`	`getTriggerId()`
`Mode`	`getTriggerMode()`
`long`	`getTrueEvalsStartTime()`
`Dampening.Type`	`getType()`
`int`	`hashCode()`
`boolean`	`isSatisfied()`
`String`	`log()`
`void`	`perform(Match match, ConditionEval conditionEval)`
`void`	`reset()`
`void`	`setEvalTimeSetting(long evalTimeSetting)`
`void`	`setEvalTotalSetting(int evalTotalSetting)`
`void`	`setEvalTrueSetting(int evalTrueSetting)`
`void`	`setNumEvals(int numEvals)`
`void`	`setNumTrueEvals(int numTrueEvals)`
`void`	`setSatisfied(boolean satisfied)`
`void`	`setSatisfyingEvals(List<Set<ConditionEval>> satisfyingEvals)`
`void`	`setTenantId(String tenantId)`
`void`	`setTriggerId(String triggerId)`
`void`	`setTriggerMode(Mode triggerMode)`
`void`	`setTrueEvalsStartTime(long trueEvalsStartTime)`
`void`	`setType(Dampening.Type type)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - dampeningId
```
protected String dampeningId
```
    A composed key for the dampening
- Constructor Detail
  - Dampening
```
public Dampening()
```
  - Dampening
```
public Dampening(String triggerId,
                 Mode triggerMode,
                 Dampening.Type type,
                 int evalTrueSetting,
                 int evalTotalSetting,
                 long evalTimeSetting)
```
- Method Detail
  - forStrict
```
public static Dampening forStrict(String triggerId,
                                  Mode triggerMode,
                                  int numConsecutiveTrueEvals)
```
    Fire if we have numTrueEvals consecutive true evaluations of the condition set. There is no time limit for the evaluations.
    
    Parameters:
    
    triggerId - the triggerId
    
    triggerMode - the trigger mode for when this dampening is active
    
    numConsecutiveTrueEvals - the numConsecutiveTrueEvals, >= 1.
    
    Returns:
    
    the configured Dampening
  - forRelaxedCount
```
public static Dampening forRelaxedCount(String triggerId,
                                        Mode triggerMode,
                                        int numTrueEvals,
                                        int numTotalEvals)
```
    Fire if we have numTrueEvals of the condition set out of numTotalEvals. There is no time limit for the evaluations.
    
    Parameters:
    
    triggerId - the triggerId
    
    triggerMode - the trigger mode for when this dampening is active
    
    numTrueEvals - the numTrueEvals, >=1
    
    numTotalEvals - the numTotalEvals, > numTotalEvals
    
    Returns:
    
    the configured Dampening
  - forRelaxedTime
```
public static Dampening forRelaxedTime(String triggerId,
                                       Mode triggerMode,
                                       int numTrueEvals,
                                       long evalPeriod)
```
    Fire if we have numTrueEvals of the condition set within evalPeriod. This can only fire if the condition set is evaluated the required number of times in the given evalPeriod, so the requisite data must be supplied in a timely manner.
    
    Parameters:
    
    triggerId - the triggerId
    
    triggerMode - the trigger mode for when this dampening is active
    
    numTrueEvals - the numTrueEvals, >= 1.
    
    evalPeriod - Elapsed real time, in milliseconds. In other words, this is not measured against collectionTimes (i.e. the timestamp on the data) but rather the evaluation times. >=1ms.
    
    Returns:
    
    the configured Dampening
  - forStrictTime
```
public static Dampening forStrictTime(String triggerId,
                                      Mode triggerMode,
                                      long evalPeriod)
```
    Fire if we have only true evaluations of the condition set for at least evalPeriod. In other words, fire the Trigger after N consecutive true condition set evaluations, such that N GTE 2 and delta(evalTime-1,evalTime-N) GTE evalPeriod. Any false evaluation resets the dampening.
    
    Parameters:
    
    triggerId - the triggerId
    
    triggerMode - the trigger mode for when this dampening is active
    
    evalPeriod - Elapsed real time, in milliseconds. In other words, this is not measured against collectionTimes (i.e. the timestamp on the data) but rather the evaluation times. >=1ms.
    
    Returns:
    
    the configured Dampening
  - forStrictTimeout
```
public static Dampening forStrictTimeout(String triggerId,
                                         Mode triggerMode,
                                         long evalPeriod)
```
    Fire if we have only true evaluations of the condition set for evalPeriod. In other words, fire the Trigger after N consecutive true condition set evaluations, such that N GTE 1 and delta(evalTime-1,currentTime) == evalPeriod. Any false evaluation resets the dampening.
    
    Parameters:
    
    triggerId - the triggerId
    
    triggerMode - the trigger mode for when this dampening is active
    
    evalPeriod - Elapsed real time, in milliseconds. In other words, this is not measured against collectionTimes (i.e. the timestamp on the data) but rather the clock starts at true-evaluation-time-1. >=1ms.
    
    Returns:
    
    the configured Dampening
  - getTriggerId
```
public String getTriggerId()
```
  - setTriggerId
```
public void setTriggerId(String triggerId)
```
  - getTriggerMode
```
public Mode getTriggerMode()
```
  - setTriggerMode
```
public void setTriggerMode(Mode triggerMode)
```
  - setEvalTimeSetting
```
public void setEvalTimeSetting(long evalTimeSetting)
```
  - setEvalTotalSetting
```
public void setEvalTotalSetting(int evalTotalSetting)
```
  - setEvalTrueSetting
```
public void setEvalTrueSetting(int evalTrueSetting)
```
  - setSatisfied
```
public void setSatisfied(boolean satisfied)
```
  - setSatisfyingEvals
```
public void setSatisfyingEvals(List<Set<ConditionEval>> satisfyingEvals)
```
  - setType
```
public void setType(Dampening.Type type)
```
  - getNumTrueEvals
```
public int getNumTrueEvals()
```
  - setNumTrueEvals
```
public void setNumTrueEvals(int numTrueEvals)
```
  - getTrueEvalsStartTime
```
public long getTrueEvalsStartTime()
```
  - setTrueEvalsStartTime
```
public void setTrueEvalsStartTime(long trueEvalsStartTime)
```
  - getNumEvals
```
public int getNumEvals()
```
  - setNumEvals
```
public void setNumEvals(int numEvals)
```
  - getType
```
public Dampening.Type getType()
```
  - getEvalTrueSetting
```
public int getEvalTrueSetting()
```
  - getEvalTotalSetting
```
public int getEvalTotalSetting()
```
  - getEvalTimeSetting
```
public long getEvalTimeSetting()
```
  - getCurrentEvals
```
public Map<Integer,ConditionEval> getCurrentEvals()
```
  - isSatisfied
```
public boolean isSatisfied()
```
  - getSatisfyingEvals
```
public List<Set<ConditionEval>> getSatisfyingEvals()
```
    Returns:
    
    a safe, but not deep, copy of the satisfying evals List
  - addSatisfyingEvals
```
public void addSatisfyingEvals(Set<ConditionEval> satisfyingEvals)
```
  - addSatisfyingEvals
```
public void addSatisfyingEvals(ConditionEval... satisfyingEvals)
```
  - getTenantId
```
public String getTenantId()
```
  - setTenantId
```
public void setTenantId(String tenantId)
```
  - perform
```
public void perform(Match match,
                    ConditionEval conditionEval)
```
  - reset
```
public void reset()
```
  - log
```
public String log()
```
  - getDampeningId
```
public String getDampeningId()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Dampening

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dampeningId

Constructor Detail

Dampening

Dampening

Method Detail

forStrict

forRelaxedCount

forRelaxedTime

forStrictTime

forStrictTimeout

getTriggerId

setTriggerId

getTriggerMode

setTriggerMode

setEvalTimeSetting

setEvalTotalSetting

setEvalTrueSetting

setSatisfied

setSatisfyingEvals

setType

getNumTrueEvals

setNumTrueEvals

getTrueEvalsStartTime

setTrueEvalsStartTime

getNumEvals

setNumEvals

getType

getEvalTrueSetting

getEvalTotalSetting

getEvalTimeSetting

getCurrentEvals

isSatisfied

getSatisfyingEvals

addSatisfyingEvals

addSatisfyingEvals

getTenantId

setTenantId

perform

reset

log

getDampeningId

hashCode

equals

toString