AlertDefinitionEntity (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.orm.entities.AlertDefinitionEntity

```
@Entity
public class AlertDefinitionEntity
extends Object
```
The AlertDefinitionEntity class is used to model an alert that needs to run in the system. Each received alert from an agent will essentially be an instance of this template.

Constructor Summary

Constructors
Constructor and Description

AlertDefinitionEntity()
Constructor.

Constructors
Constructor and Description
`AlertDefinitionEntity()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAlertGroup(AlertGroupEntity alertGroup)` Adds the specified alert group to the groups that this definition is associated with.
`boolean`	`equals(Object object)` Gets the equality to another historical alert entry based on the following criteria: `definitionId` `clusterId` `definitionName` However, since we're guaranteed that `definitionId` is unique among persisted entities, we can return the hashCode based on this value if it is set.
`Set<AlertGroupEntity>`	`getAlertGroups()` Gets the alert groups that this alert definition is associated with.
`ClusterEntity`	`getCluster()` Gets the cluster that this alert definition is a member of.
`Long`	`getClusterId()` Gets the ID of the cluster that this alert definition is created for.
`String`	`getComponentName()` Gets the component name that this alert is associated with, if any.
`Long`	`getDefinitionId()` Gets the unique identifier for this alert definition.
`String`	`getDefinitionName()` Gets the name of this alert definition.
`String`	`getDescription()` Gets the optional description for this alert definition.
`boolean`	`getEnabled()` Gets whether this alert definition is enabled.
`String`	`getHash()` Gets the unique hash for the current state of this definition.
`String`	`getHelpURL()` Gets the help url for this alert.
`String`	`getLabel()` Gets the label for this alert definition.
`int`	`getRepeatTolerance()` Gets the number of sequential instances of an non-OK `AlertState` must be received in order to consider the alert instance as truly being in that `AlertState`.
`Integer`	`getScheduleInterval()` Gets the alert trigger interval, in seconds.
`Scope`	`getScope()` Gets the scope of the alert definition.
`String`	`getServiceName()` Gets the name of the service that this alert definition is associated with.
`String`	`getSource()` Gets the source that defines the type of alert and the alert properties.
`SourceType`	`getSourceType()`
`int`	`hashCode()` Gets a hash to uniquely identify this alert definition.
`boolean`	`isHostIgnored()` Gets whether this alert definition will ignore the hosts reporting the alert and combine them all into a single alert entry.
`boolean`	`isRepeatToleranceEnabled()` Gets whether this definition overrides the default global tolerance value specified in `cluster-env/alerts.repeat.tolerance`.
`void`	`preRemove()` Called before `EntityManager.remove(Object)` for this entity, removes the non-owning relationship between definitions and groups.
`protected void`	`removeAlertGroup(AlertGroupEntity alertGroup)` Removes the specified alert group to the groups that this definition is associated with.
`void`	`setAlertGroups(Set<AlertGroupEntity> alertGroups)` Sets the alert groups that this alert definition is associated with.
`void`	`setCluster(ClusterEntity clusterEntity)` Sets the cluster that the alert definition is a member of.
`void`	`setClusterId(Long clusterId)` Sets the ID of the cluster that this alert definition is created for.
`void`	`setComponentName(String componentName)` Sets the component name that this alert is associated with, if any.
`void`	`setDefinitionId(Long definitionId)` Sets the unique identifier for this alert definition.
`void`	`setDefinitionName(String definitionName)` Sets the name of this alert definition.
`void`	`setDescription(String description)` Gets the optional description for this alert definition.
`void`	`setEnabled(boolean enabled)` Sets whether this alert definition is enabled.
`void`	`setHash(String hash)` Gets the unique hash for the current state of this definition.
`void`	`setHelpURL(String helpURL)` Sets a help url for this alert.
`void`	`setHostIgnored(boolean ignoreHost)` Sets whether this alert definition will ignore the hosts reporting the alert and combine them all into a single alert entry.
`void`	`setLabel(String label)` Sets a human readable label for this alert definition.
`void`	`setRepeatTolerance(int repeatTolerance)` Sets the number of sequential instances of an non-OK `AlertState` must be received in order to consider the alert instance as truly being in that `AlertState`.
`void`	`setRepeatToleranceEnabled(boolean enabled)` Sets whether this definition overrides the default global tolerance value specified in `cluster-env/alerts.repeat.tolerance`.
`void`	`setScheduleInterval(Integer scheduleInterval)` Sets the alert trigger interval, in seconds.
`void`	`setScope(Scope scope)` Sets the scope of the alert definition.
`void`	`setServiceName(String serviceName)` Gets the name of the service that this alert definition is associated with.
`void`	`setSource(String alertSource)` Sets the source of the alert, typically in JSON, that defines the type of the alert and its properties.
`void`	`setSourceType(SourceType sourceType)`
`String`	`toString()`

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

- Constructor Detail
  - AlertDefinitionEntity
```
public AlertDefinitionEntity()
```
    Constructor.
- Method Detail
  - getDefinitionId
```
public Long getDefinitionId()
```
    Gets the unique identifier for this alert definition.
    
    Returns:
    
    the ID.
  - setDefinitionId
```
public void setDefinitionId(Long definitionId)
```
    Sets the unique identifier for this alert definition.
    
    Parameters:
    
    definitionId - the ID (not null).
  - getSource
```
public String getSource()
```
    Gets the source that defines the type of alert and the alert properties. This is typically a JSON structure that can be mapped to a first-class object.
    
    Returns:
    
    the alert source (never null).
  - setSource
```
public void setSource(String alertSource)
```
    Sets the source of the alert, typically in JSON, that defines the type of the alert and its properties.
    
    Parameters:
    
    alertSource - the alert source (not null).
  - getClusterId
```
public Long getClusterId()
```
    Gets the ID of the cluster that this alert definition is created for. Each cluster has their own set of alert definitions that are not shared with any other cluster.
    
    Returns:
    
    the ID of the cluster (never null).
  - setClusterId
```
public void setClusterId(Long clusterId)
```
    Sets the ID of the cluster that this alert definition is created for. Each cluster has their own set of alert definitions that are not shared with any other cluster.
    
    Parameters:
    
    clusterId - the ID of the cluster (not null).
  - getCluster
```
public ClusterEntity getCluster()
```
    Gets the cluster that this alert definition is a member of.
    
    Returns:
  - setCluster
```
public void setCluster(ClusterEntity clusterEntity)
```
    Sets the cluster that the alert definition is a member of.
    
    Parameters:
    
    clusterEntity -
  - getComponentName
```
public String getComponentName()
```
    Gets the component name that this alert is associated with, if any. Some alerts are scoped at the service level and will not have a component name.
    
    Returns:
    
    the component name or null if none.
  - setComponentName
```
public void setComponentName(String componentName)
```
    Sets the component name that this alert is associated with, if any. Some alerts are scoped at the service level and will not have a component name.
    
    Parameters:
    
    componentName - the component name or null if none.
  - getScope
```
public Scope getScope()
```
    Gets the scope of the alert definition. The scope is defined as either being for a Scope.SERVICE or Scope.HOST.
    
    Returns:
    
    the scope, or null if not defined.
  - setScope
```
public void setScope(Scope scope)
```
    Sets the scope of the alert definition. The scope is defined as either being for a Scope.SERVICE or Scope.HOST.
    
    Parameters:
    
    scope - the scope to set, or null for none.
  - getDefinitionName
```
public String getDefinitionName()
```
    Gets the name of this alert definition. Alert definition names are unique within a cluster.
    
    Returns:
    
    the name of the alert definition (never null).
  - setDefinitionName
```
public void setDefinitionName(String definitionName)
```
    Sets the name of this alert definition. Alert definition names are unique within a cluster.
    
    Parameters:
    
    definitionName - the name of the alert definition (not null).
  - getEnabled
```
public boolean getEnabled()
```
    Gets whether this alert definition is enabled. Disabling an alert definition will prevent agents from scheduling the alerts. No alerts will be triggered and no alert data will be collected.
    
    Returns:
    
    true if this alert definition is enabled, false otherwise.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets whether this alert definition is enabled.
    
    Parameters:
    
    enabled - true if this alert definition is enabled, false otherwise.
  - isHostIgnored
```
public boolean isHostIgnored()
```
    Gets whether this alert definition will ignore the hosts reporting the alert and combine them all into a single alert entry.
    
    Returns:
    
    true if this alert definition is to ignore hosts and combine all alert instances into a single entry, false otherwise.
  - setHostIgnored
```
public void setHostIgnored(boolean ignoreHost)
```
    Sets whether this alert definition will ignore the hosts reporting the alert and combine them all into a single alert entry.
    
    Parameters:
    
    ignoreHost - true if this alert definition is to ignore hosts and combine all alert instances into a single entry, false otherwise.
  - getHash
```
public String getHash()
```
    Gets the unique hash for the current state of this definition. If a property of this definition changes, a new hash is calculated.
    
    Returns:
    
    the unique hash or null if there is none.
  - setHash
```
public void setHash(String hash)
```
    Gets the unique hash for the current state of this definition. If a property of this definition changes, a new hash is calculated.
    
    Parameters:
    
    hash - the unique hash to set or null for none.
  - getScheduleInterval
```
public Integer getScheduleInterval()
```
    Gets the alert trigger interval, in seconds.
    
    Returns:
    
    the interval, in seconds.
  - setScheduleInterval
```
public void setScheduleInterval(Integer scheduleInterval)
```
    Sets the alert trigger interval, in seconds.
    
    Parameters:
    
    scheduleInterval - the interval, in seconds.
  - getServiceName
```
public String getServiceName()
```
    Gets the name of the service that this alert definition is associated with. Every alert definition is associated with exactly one service.
    
    Returns:
    
    the name of the service (never null).
  - setServiceName
```
public void setServiceName(String serviceName)
```
    Gets the name of the service that this alert definition is associated with. Every alert definition is associated with exactly one service.
    
    Parameters:
    
    serviceName - the name of the service (not null).
  - getSourceType
```
public SourceType getSourceType()
```
    Returns:
  - setSourceType
```
public void setSourceType(SourceType sourceType)
```
    Parameters:
    
    sourceType -
  - getAlertGroups
```
public Set<AlertGroupEntity> getAlertGroups()
```
    Gets the alert groups that this alert definition is associated with.
    
    Returns:
    
    the groups, or null if none.
  - setAlertGroups
```
public void setAlertGroups(Set<AlertGroupEntity> alertGroups)
```
    Sets the alert groups that this alert definition is associated with.
    
    Parameters:
    
    alertGroups - the groups, or null for none.
  - setLabel
```
public void setLabel(String label)
```
    Sets a human readable label for this alert definition.
    
    Parameters:
    
    label - the label or null if none.
  - getLabel
```
public String getLabel()
```
    Gets the label for this alert definition.
    
    Returns:
    
    the label or null if none.
  - getHelpURL
```
public String getHelpURL()
```
    Gets the help url for this alert.
    
    Returns:
    
    the helpURL or null if none.
  - setHelpURL
```
public void setHelpURL(String helpURL)
```
    Sets a help url for this alert.
    
    Parameters:
    
    helpURL - the helpURL or null if none.
  - getDescription
```
public String getDescription()
```
    Gets the optional description for this alert definition.
    
    Returns:
    
    the description, or null if none.
  - setDescription
```
public void setDescription(String description)
```
    Gets the optional description for this alert definition.
    
    Parameters:
    
    description - the description to set or null for none.
  - getRepeatTolerance
```
public int getRepeatTolerance()
```
    Gets the number of sequential instances of an non-OK AlertState must be received in order to consider the alert instance as truly being in that AlertState.
    A value of 1 or less indicates that there is no tolerance and a single alert will cause dispatching of alert notifications.
    
    Returns:
    
    the repeatTolerance
  - setRepeatTolerance
```
public void setRepeatTolerance(int repeatTolerance)
```
    Sets the number of sequential instances of an non-OK AlertState must be received in order to consider the alert instance as truly being in that AlertState.
    A value of 1 or less indicates that there is no tolerance and a single alert will cause dispatching of alert notifications.
    
    Parameters:
    
    repeatTolerance - the tolerance to set
  - isRepeatToleranceEnabled
```
public boolean isRepeatToleranceEnabled()
```
    Gets whether this definition overrides the default global tolerance value specified in cluster-env/alerts.repeat.tolerance. If enabled, the value from getRepeatTolerance() should be used to calculate retry tolerance.
    
    Returns:
    
    the repeatToleranceEnabled true to override the global value.
  - setRepeatToleranceEnabled
```
public void setRepeatToleranceEnabled(boolean enabled)
```
    Sets whether this definition overrides the default global tolerance value specified in cluster-env/alerts.repeat.tolerance. If enabled, the value from getRepeatTolerance() should be used to calculate retry tolerance.
    
    Parameters:
    
    enabled - true to override the defautlt value and use the value returned from getRepeatTolerance().
  - addAlertGroup
```
protected void addAlertGroup(AlertGroupEntity alertGroup)
```
    Adds the specified alert group to the groups that this definition is associated with. This is used to complement the JPA bidirectional association.
    
    Parameters:
    
    alertGroup -
  - removeAlertGroup
```
protected void removeAlertGroup(AlertGroupEntity alertGroup)
```
    Removes the specified alert group to the groups that this definition is associated with. This is used to complement the JPA bidirectional association.
    
    Parameters:
    
    alertGroup -
  - preRemove
```
public void preRemove()
```
    Called before EntityManager.remove(Object) for this entity, removes the non-owning relationship between definitions and groups.
  - equals
```
public boolean equals(Object object)
```
    Gets the equality to another historical alert entry based on the following criteria:
    However, since we're guaranteed that definitionId is unique among persisted entities, we can return the hashCode based on this value if it is set.
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Gets a hash to uniquely identify this alert definition. Since we're guaranteed that definitionId is unique among persisted entities, we can return the hashCode based on this value if it is set.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AlertDefinitionEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlertDefinitionEntity

Method Detail

getDefinitionId

setDefinitionId

getSource

setSource

getClusterId

setClusterId

getCluster

setCluster

getComponentName

setComponentName

getScope

setScope

getDefinitionName

setDefinitionName

getEnabled

setEnabled

isHostIgnored

setHostIgnored

getHash

setHash

getScheduleInterval

setScheduleInterval

getServiceName

setServiceName

getSourceType

setSourceType

getAlertGroups

setAlertGroups

setLabel

getLabel

getHelpURL

setHelpURL

getDescription

setDescription

getRepeatTolerance

setRepeatTolerance

isRepeatToleranceEnabled

setRepeatToleranceEnabled

addAlertGroup

removeAlertGroup

preRemove

equals

hashCode

toString