LossMeasurementThreshold (ONOS Java API (1.12.0))

All Known Implementing Classes:

DefaultLmThreshold
```
public interface LossMeasurementThreshold
```
Object to support the setting of Loss Measurement Thresholds. The main purpose of the threshold configuration is to configure threshold alarm notifications indicating that a specific performance metric is not being met

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`LossMeasurementThreshold.LmThresholdBuilder` Builder for `LossMeasurementThreshold`.
`static class`	`LossMeasurementThreshold.ThresholdOption` Set of enumerated threshold options.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`MilliPct`	`averageFlrBackward()` The average backward frame loss ratio threshold value.
`MilliPct`	`averageFlrForward()` The average forward frame loss ratio threshold value.
`MilliPct`	`backwardAvailableRatio()` The backward availability/total time ratio threshold value.
`java.lang.Long`	`backwardConsecutiveHighLoss()` The consecutive backward high loss threshold value.
`java.lang.Long`	`backwardHighLoss()` The backward high loss threshold value.
`java.lang.Long`	`backwardUnavailableCount()` The backward unavailability threshold value.
`MilliPct`	`forwardAvailableRatio()` The forward availability/total time ratio threshold value.
`java.lang.Long`	`forwardConsecutiveHighLoss()` The consecutive forward high loss threshold value.
`java.lang.Long`	`forwardHighLoss()` The forward high loss threshold value.
`java.lang.Long`	`forwardUnavailableCount()` The forward unavailability threshold value.
`MilliPct`	`maxFlrBackward()` The maximum backward frame loss ratio threshold value.
`MilliPct`	`maxFlrForward()` The maximum forward frame loss ratio threshold value.
`MilliPct`	`measuredFlrBackward()` The measured backward frame loss ratio threshold value.
`MilliPct`	`measuredFlrForward()` The measured forward frame loss ratio threshold value.
`SoamId`	`thresholdId()` The index of the threshold number for the specific LM threshold entry.
`java.util.Collection<LossMeasurementThreshold.ThresholdOption>`	`thresholds()` A vector of bits that indicates the type of SOAM LM thresholds notifications that are enabled.

- Method Detail
  - thresholdId
```
SoamId thresholdId()
```
    The index of the threshold number for the specific LM threshold entry. An index value of '1' needs to be supported. Other index values can also be supported
    
    Returns:
    
    The threshold Id
  - thresholds
```
java.util.Collection<LossMeasurementThreshold.ThresholdOption> thresholds()
```
    A vector of bits that indicates the type of SOAM LM thresholds notifications that are enabled. A present but enables the specific SOAM LM threshold notification and when the specific counter is enabled and the threshold is crossed a notification is generated. A not present bit disables the specific SOAM LM threshold notification. If a particular SOAM LM threshold is not supported the BIT value is not present
    
    Returns:
    
    A collection of bit options
  - measuredFlrForward
```
MilliPct measuredFlrForward()
```
    The measured forward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated
    
    Returns:
    
    Units are in milli-percent, where 1 indicates 0.001 percent
  - maxFlrForward
```
MilliPct maxFlrForward()
```
    The maximum forward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated
    
    Returns:
    
    Units are in milli-percent, where 1 indicates 0.001 percent
  - averageFlrForward
```
MilliPct averageFlrForward()
```
    The average forward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated
    
    Returns:
    
    Units are in milli-percent, where 1 indicates 0.001 percent
  - measuredFlrBackward
```
MilliPct measuredFlrBackward()
```
    The measured backward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated
    
    Returns:
    
    Units are in milli-percent, where 1 indicates 0.001 percent
  - maxFlrBackward
```
MilliPct maxFlrBackward()
```
    The maximum backward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated
    
    Returns:
    
    Units are in milli-percent, where 1 indicates 0.001 percent
  - averageFlrBackward
```
MilliPct averageFlrBackward()
```
    The average backward frame loss ratio threshold value. that will be used to determine if a threshold notification is generated
    
    Returns:
    
    Units are in milli-percent, where 1 indicates 0.001 percent
  - forwardHighLoss
```
java.lang.Long forwardHighLoss()
```
    The forward high loss threshold value. that will be used to determine if a threshold notification is generated.
    
    Returns:
    
    The threshold value
  - forwardConsecutiveHighLoss
```
java.lang.Long forwardConsecutiveHighLoss()
```
    The consecutive forward high loss threshold value. that will be used to determine if a threshold notification is generated
    
    Returns:
    
    The threshold value
  - backwardHighLoss
```
java.lang.Long backwardHighLoss()
```
    The backward high loss threshold value. that will be used to determine if a threshold notification is generated.
    
    Returns:
    
    The threshold value
  - backwardConsecutiveHighLoss
```
java.lang.Long backwardConsecutiveHighLoss()
```
    The consecutive backward high loss threshold value. that will be used to determine if a threshold notification is generated
    
    Returns:
    
    The threshold value
  - forwardUnavailableCount
```
java.lang.Long forwardUnavailableCount()
```
    The forward unavailability threshold value. that will be used to determine if a threshold notification is generated
    
    Returns:
    
    The threshold value
  - forwardAvailableRatio
```
MilliPct forwardAvailableRatio()
```
    The forward availability/total time ratio threshold value. that will be used to determine if a threshold notification is generated if the ratio drops below the configured value. The ratio value is expressed as a percent with a value of 0 (ratio 0.00) through 100000 (ratio 1.00)
    
    Returns:
    
    Units are in milli-percent, where 1 indicates 0.001 percent
  - backwardUnavailableCount
```
java.lang.Long backwardUnavailableCount()
```
    The backward unavailability threshold value. that will be used to determine if a threshold notification is generated
    
    Returns:
    
    The threshold value
  - backwardAvailableRatio
```
MilliPct backwardAvailableRatio()
```
    The backward availability/total time ratio threshold value. that will be used to determine if a threshold notification is generated if the ratio drops below the configured value. The ratio value is expressed as a percent with a value of 0 (ratio 0.00) through 100000 (ratio 1.00)
    
    Returns:
    
    Units are in milli-percent, where 1 indicates 0.001 percent

Interface LossMeasurementThreshold

Nested Class Summary

Method Summary

Method Detail

thresholdId

thresholds

measuredFlrForward

maxFlrForward

averageFlrForward

measuredFlrBackward

maxFlrBackward

averageFlrBackward

forwardHighLoss

forwardConsecutiveHighLoss

backwardHighLoss

backwardConsecutiveHighLoss

forwardUnavailableCount

forwardAvailableRatio

backwardUnavailableCount

backwardAvailableRatio