AlertDefinition (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.state.alert.AlertDefinition

```
public class AlertDefinition
extends Object
```
The AlertDefinition class represents all of the necessary information to schedule, run, and collect alerts.
Although all members of this class must define a complex equals and hashCode method, this class itself does not. Instead, equals(Object) is defined as a name comparison only since name is unique to a definition. This allows us to easily insert instances of this class into a HashSet if necessary.
When making comparisons for equality for things like stack/database merging, use deeplyEquals(Object).

Constructor Summary

Constructors
Constructor and Description

AlertDefinition()

Constructors
Constructor and Description
`AlertDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Alert`	`buildAlert(double value, List<Object> args)` Map the incoming value to `AlertState` and generate an alert with that state.
`boolean`	`deeplyEquals(Object obj)` Compares `equals(Object)` of every field.
`boolean`	`equals(Object obj)` Gets equality based on name only.
`long`	`getClusterId()` Gets the cluster ID for this definition.
`String`	`getComponentName()`
`long`	`getDefinitionId()`
`String`	`getDescription()`
`String`	`getHelpURL()`
`int`	`getInterval()`
`String`	`getLabel()`
`String`	`getName()`
`int`	`getRepeatTolerance()`
`Boolean`	`getRepeatToleranceEnabled()`
`Scope`	`getScope()`
`String`	`getServiceName()`
`Source`	`getSource()`
`String`	`getUuid()` Gets the UUID of the definition.
`int`	`hashCode()` Gets a hash based on name only.
`boolean`	`isEnabled()`
`boolean`	`isHostIgnored()`
`Set<String>`	`matchingHosts(Clusters clusters)` Collect the host names from the cluster where the given alert is allowed to run.
`void`	`setClusterId(long clusterId)` Sets the cluster ID for this definition.
`void`	`setComponentName(String name)`
`void`	`setDefinitionId(long definitionId)`
`void`	`setDescription(String description)`
`void`	`setEnabled(boolean definitionEnabled)`
`void`	`setHelpURL(String helpURL)` Sets the help url for this definition.
`void`	`setHostIgnored(boolean definitionHostIgnored)`
`void`	`setInterval(int definitionInterval)`
`void`	`setLabel(String definitionLabel)` Sets the label for this definition.
`void`	`setName(String definitionName)`
`void`	`setRepeatTolerance(int repeatTolerance)`
`void`	`setRepeatToleranceEnabled(Boolean repeatToleranceEnabled)`
`void`	`setScope(Scope definitionScope)`
`void`	`setServiceName(String name)`
`void`	`setSource(Source definitionSource)`
`void`	`setUuid(String definitionUuid)` Sets the UUID of the definition
`String`	`toString()`

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

- Constructor Detail
  - AlertDefinition
```
public AlertDefinition()
```
- Method Detail
  - getClusterId
```
public long getClusterId()
```
    Gets the cluster ID for this definition.
    
    Returns:
  - setClusterId
```
public void setClusterId(long clusterId)
```
    Sets the cluster ID for this definition.
    
    Parameters:
    
    clusterId -
  - getDefinitionId
```
public long getDefinitionId()
```
    Returns:
    
    the definitionId
  - setDefinitionId
```
public void setDefinitionId(long definitionId)
```
    Parameters:
    
    definitionId - the definitionId to set
  - getServiceName
```
public String getServiceName()
```
    Returns:
    
    the service name
  - setServiceName
```
public void setServiceName(String name)
```
    Parameters:
    
    name - the service name
  - getComponentName
```
public String getComponentName()
```
    Returns:
    
    the component name
  - setComponentName
```
public void setComponentName(String name)
```
    Parameters:
    
    name - the component name
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - setName
```
public void setName(String definitionName)
```
    Parameters:
    
    definitionName - the definition name.
  - getScope
```
public Scope getScope()
```
    Returns:
    
    the scope
  - setScope
```
public void setScope(Scope definitionScope)
```
  - getInterval
```
public int getInterval()
```
    Returns:
    
    the interval
  - setInterval
```
public void setInterval(int definitionInterval)
```
  - isEnabled
```
public boolean isEnabled()
```
    Returns:
    
    true if enabled
  - setEnabled
```
public void setEnabled(boolean definitionEnabled)
```
  - isHostIgnored
```
public boolean isHostIgnored()
```
    Returns:
    
    true if the host is ignored.
  - setHostIgnored
```
public void setHostIgnored(boolean definitionHostIgnored)
```
  - getSource
```
public Source getSource()
```
  - setSource
```
public void setSource(Source definitionSource)
```
  - getLabel
```
public String getLabel()
```
    Returns:
    
    the label for the definition or null if none.
  - setLabel
```
public void setLabel(String definitionLabel)
```
    Sets the label for this definition.
    
    Parameters:
    
    definitionLabel -
  - getHelpURL
```
public String getHelpURL()
```
    Returns:
    
    the help url for this definition or null if none.
  - setHelpURL
```
public void setHelpURL(String helpURL)
```
    Sets the help url for this definition.
    
    Parameters:
    
    helpURL -
  - getDescription
```
public String getDescription()
```
    Returns:
    
    the description
  - setDescription
```
public void setDescription(String description)
```
    Parameters:
    
    description - the description to set
  - setUuid
```
public void setUuid(String definitionUuid)
```
    Sets the UUID of the definition
    
    Parameters:
    
    definitionUuid -
  - getUuid
```
public String getUuid()
```
    Gets the UUID of the definition. The UUID is a unique identifier that is generated every time the definition's state changes.
    
    Returns:
    
    the UUID
  - getRepeatTolerance
```
public int getRepeatTolerance()
```
  - setRepeatTolerance
```
public void setRepeatTolerance(int repeatTolerance)
```
  - getRepeatToleranceEnabled
```
public Boolean getRepeatToleranceEnabled()
```
  - setRepeatToleranceEnabled
```
public void setRepeatToleranceEnabled(Boolean repeatToleranceEnabled)
```
  - deeplyEquals
```
public boolean deeplyEquals(Object obj)
```
    Compares equals(Object) of every field. This is used mainly for reconciling the stack versus the database.
    
    Parameters:
    
    obj -
    
    Returns:
  - buildAlert
```
public Alert buildAlert(double value,
                        List<Object> args)
```
    Map the incoming value to AlertState and generate an alert with that state.
  - equals
```
public boolean equals(Object obj)
```
    Gets equality based on name only.
    
    Overrides:
    
    equals in class Object
    
    See Also:
    
    deeplyEquals(Object)
  - hashCode
```
public int hashCode()
```
    Gets a hash based on name only.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - matchingHosts
```
public Set<String> matchingHosts(Clusters clusters)
                          throws org.apache.ambari.server.AmbariException
```
    Collect the host names from the cluster where the given alert is allowed to run. A host is able to run an alert if the service component of the alert is installed on that particular host. In case of AMBARI server alerts or AGGREGATE alerts, an empty host set is returned.
    
    Returns:
    
    matching host names
    
    Throws:
    
    org.apache.ambari.server.AmbariException

Class AlertDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlertDefinition

Method Detail

getClusterId

setClusterId

getDefinitionId

setDefinitionId

getServiceName

setServiceName

getComponentName

setComponentName

getName

setName

getScope

setScope

getInterval

setInterval

isEnabled

setEnabled

isHostIgnored

setHostIgnored

getSource

setSource

getLabel

setLabel

getHelpURL

setHelpURL

getDescription

setDescription

setUuid

getUuid

getRepeatTolerance

setRepeatTolerance

getRepeatToleranceEnabled

setRepeatToleranceEnabled

deeplyEquals

buildAlert

equals

hashCode

toString

matchingHosts