AlertHistoryEntity (Ambari Server 3.0.0.0-SNAPSHOT API)

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

```
@Entity
public class AlertHistoryEntity
extends Object
```
The AlertHistoryEntity class is an instance of an alert state change that was received. Instances are only stored in the history if there is a state change event. Subsequent alerts that are received for the same state update the timestamps in AlertNoticeEntity but do not receive a new AlertHistoryEntity.

Constructor Summary

Constructors
Constructor and Description

AlertHistoryEntity()
Constructor.

Constructors
Constructor and Description
`AlertHistoryEntity()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)` Gets the equality to another historical alert entry based on the following criteria: `alertId` `clusterId` `alertInstance` `alertLabel` `alertState` `alertText` `alertTimestamp` `serviceName` `componentName` `hostName` `alertDefinition` However, since we're guaranteed that `alertId` is unique among persisted entities, we can return the hashCode based on this value if it is set.
`AlertDefinitionEntity`	`getAlertDefinition()` Gets the associated alert definition for this alert instance.
`int`	`getAlertDefinitionHash()`
`Long`	`getAlertDefinitionId()` Get parent alert definition id
`Long`	`getAlertId()` Gets the unique ID for this alert instance.
`String`	`getAlertInstance()` Gets the instance identifier, if any, for this alert instance.
`String`	`getAlertLabel()` Gets the label for this alert instance.
`AlertState`	`getAlertState()` Gets the state of this alert instance.
`String`	`getAlertText()` Gets the text of the alert instance.
`Long`	`getAlertTimestamp()` Gets the time that the alert instace was received.
`Long`	`getClusterId()` Gets the ID of the cluster that this alert is associated with.
`String`	`getComponentName()` Gets the name of the component, if any, that this alert instance is for.
`String`	`getHostName()` Gets the name of the host that the alert is for.
`String`	`getServiceName()` Gets the name of the service that the alert is defined for.
`int`	`hashCode()` Gets a hash to uniquely identify this historical alert instance.
`void`	`setAlertDefinition(AlertDefinitionEntity alertDefinition)` Sets the associated alert definition for this alert instance.
`void`	`setAlertDefinitionId(Long alertDefinitionId)` Set parent alert definition id
`void`	`setAlertId(Long alertId)` Sets the unique ID for this alert instance.
`void`	`setAlertInstance(String alertInstance)` Sets the instance identifier, if any, for this alert instance.
`void`	`setAlertLabel(String alertLabel)` Sets the label for this alert instance.
`void`	`setAlertState(AlertState alertState)` Sets the state of this alert instance.
`void`	`setAlertText(String alertText)` Sets the text of the alert instance.
`void`	`setAlertTimestamp(Long alertTimestamp)` Sets the time that the alert instace was received.
`void`	`setClusterId(Long clusterId)` Sets the ID of the cluster that this alert is associated with.
`void`	`setComponentName(String componentName)` Sets the name of the component that this alert instance is associated with.
`void`	`setHostName(String hostName)` Sets the name of the host that the alert is for.
`void`	`setServiceName(String serviceName)` Sets the name of the service that the alert is defined for.
`String`	`toString()`

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

- Constructor Detail
  - AlertHistoryEntity
```
public AlertHistoryEntity()
```
    Constructor.
- Method Detail
  - getAlertId
```
public Long getAlertId()
```
    Gets the unique ID for this alert instance.
    
    Returns:
    
    the unique ID (never null).
  - setAlertId
```
public void setAlertId(Long alertId)
```
    Sets the unique ID for this alert instance.
    
    Parameters:
    
    alertId - the unique ID (not null).
  - getAlertInstance
```
public String getAlertInstance()
```
    Gets the instance identifier, if any, for this alert instance.
    
    Returns:
    
    the instance ID or null if none.
  - setAlertInstance
```
public void setAlertInstance(String alertInstance)
```
    Sets the instance identifier, if any, for this alert instance.
    
    Parameters:
    
    alertInstance - the instance ID or null if none.
  - getAlertLabel
```
public String getAlertLabel()
```
    Gets the label for this alert instance. The label is typically an abbreviated form of the alert text.
    
    Returns:
    
    the alert instance label or null if none.
    
    See Also:
    
    getAlertText()
  - setAlertLabel
```
public void setAlertLabel(String alertLabel)
```
    Sets the label for this alert instance.
    
    Parameters:
    
    alertLabel - the label or null if none.
  - getAlertState
```
public AlertState getAlertState()
```
    Gets the state of this alert instance.
    
    Returns:
    
    the alert state (never null).
  - setAlertState
```
public void setAlertState(AlertState alertState)
```
    Sets the state of this alert instance.
    
    Parameters:
    
    alertState - the alert state (not null).
  - getAlertText
```
public String getAlertText()
```
    Gets the text of the alert instance.
    
    Returns:
    
    the text of the alert instance or null if none.
  - setAlertText
```
public void setAlertText(String alertText)
```
    Sets the text of the alert instance.
    
    Parameters:
    
    alertText - the text, or null if none.
  - getAlertTimestamp
```
public Long getAlertTimestamp()
```
    Gets the time that the alert instace was received. This will be the value, in milliseconds, since the UNIX/Java epoch, represented in UTC time.
    
    Returns:
    
    the time of the alert instance (never null).
  - setAlertTimestamp
```
public void setAlertTimestamp(Long alertTimestamp)
```
    Sets the time that the alert instace was received. This should be the value, in milliseconds, since the UNIX/Java epoch, represented in UTC time.
    
    Parameters:
    
    alertTimestamp - the time of the alert instance (not null).
  - getClusterId
```
public Long getClusterId()
```
    Gets the ID of the cluster that this alert is associated with.
    
    Returns:
    
    the ID of the cluster for the server that this alert is for (never null).
  - setClusterId
```
public void setClusterId(Long clusterId)
```
    Sets the ID of the cluster that this alert is associated with.
    
    Parameters:
    
    clusterId - the ID of the cluster for the server that this alert is for (never null).
  - getComponentName
```
public String getComponentName()
```
    Gets the name of the component, if any, that this alert instance is for. Some alerts, such as those that are scoped for the entire service, do not have component names.
    
    Returns:
    
    the name of the component, or null for none.
  - setComponentName
```
public void setComponentName(String componentName)
```
    Sets the name of the component that this alert instance is associated with. Component names are not required if the alert definition is scoped for a service. If specified, there is always a 1:1 mapping between alert definitions and components.
    
    Parameters:
    
    componentName - the name of the component, or null if none.
  - getHostName
```
public String getHostName()
```
    Gets the name of the host that the alert is for. Some alerts do not run against hosts, such as aggregate alert definitions, so this may be null.
    
    Returns:
    
    the name of the host or null if none.
  - setHostName
```
public void setHostName(String hostName)
```
    Sets the name of the host that the alert is for.
    
    Parameters:
    
    hostName - the name of the host or null if none.
  - getServiceName
```
public String getServiceName()
```
    Gets the name of the service that the alert is defined for.
    
    Returns:
    
    the name of the service (never null).
  - setServiceName
```
public void setServiceName(String serviceName)
```
    Sets the name of the service that the alert is defined for. Every alert definition is related to exactly 1 service.
    
    Parameters:
    
    serviceName - the name of the service (not null).
  - getAlertDefinition
```
public AlertDefinitionEntity getAlertDefinition()
```
    Gets the associated alert definition for this alert instance. The alert definition can be used to retrieve global information about an alert such as the interval and the name.
    
    Returns:
    
    the alert definition (never null).
  - setAlertDefinition
```
public void setAlertDefinition(AlertDefinitionEntity alertDefinition)
```
    Sets the associated alert definition for this alert instance.
    
    Parameters:
    
    alertDefinition - the alert definition (not null).
  - getAlertDefinitionId
```
public Long getAlertDefinitionId()
```
    Get parent alert definition id
    
    Returns:
    
    definition id
  - setAlertDefinitionId
```
public void setAlertDefinitionId(Long alertDefinitionId)
```
    Set parent alert definition id
    
    Parameters:
    
    alertDefinitionId - definition id
  - 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 alertId 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 historical alert instance. Since historical entries have no real uniqueness properties, we need to rely on a combination of the fields of this entity.
    However, since we're guaranteed that alertId 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
  - getAlertDefinitionHash
```
public int getAlertDefinitionHash()
```

Class AlertHistoryEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlertHistoryEntity

Method Detail

getAlertId

setAlertId

getAlertInstance

setAlertInstance

getAlertLabel

setAlertLabel

getAlertState

setAlertState

getAlertText

setAlertText

getAlertTimestamp

setAlertTimestamp

getClusterId

setClusterId

getComponentName

setComponentName

getHostName

setHostName

getServiceName

setServiceName

getAlertDefinition

setAlertDefinition

getAlertDefinitionId

setAlertDefinitionId

equals

hashCode

toString

getAlertDefinitionHash