AlertTargetEntity (Ambari Server 3.0.0.0-SNAPSHOT API)

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

```
@Entity
public class AlertTargetEntity
extends Object
```
The AlertTargetEntity class represents audience that will receive dispatches when an alert is triggered.

Constructor Summary

Constructors
Constructor and Description

AlertTargetEntity()

Constructors
Constructor and Description
`AlertTargetEntity()`

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 target is associated with.
`protected void`	`addAlertNotice(AlertNoticeEntity notice)` Adds the specified notice to the notices that have been sent out for this target.
`boolean`	`equals(Object object)`
`Set<AlertGroupEntity>`	`getAlertGroups()` Gets an immutable set of the alert groups that this target is associated with.
`List<AlertNoticeEntity>`	`getAlertNotices()`
`Set<AlertState>`	`getAlertStates()` Gets the alert states that will cause a triggered alert to be sent to this target.
`String`	`getDescription()` Gets the description of this alert target.
`String`	`getNotificationType()`
`String`	`getProperties()`
`Long`	`getTargetId()` Gets the unique ID of this alert target.
`String`	`getTargetName()` Gets the name of this alert target.
`int`	`hashCode()`
`boolean`	`isEnabled()` Gets whether the alert target is enabled.
`boolean`	`isGlobal()` Gets whether the alert target is a global target and will receive notifications triggered for any alert group.
`void`	`preRemove()` Called before `EntityManager.remove(Object)` for this entity, removes the non-owning relationship between targets and groups.
`protected void`	`removeAlertGroup(AlertGroupEntity alertGroup)` Removes the specified alert group to the groups that this target is associated with.
`void`	`setAlertGroups(Set<AlertGroupEntity> alertGroups)` Sets all of the groups that are associated with this target.
`void`	`setAlertNotices(List<AlertNoticeEntity> alertNotices)`
`void`	`setAlertStates(Set<AlertState> alertStates)` Sets the alert states that will cause a triggered alert to be sent to this target.
`void`	`setDescription(String description)` Sets the description for this alert target.
`void`	`setEnabled(boolean isEnabled)` Sets whether the alert target is enabled.
`void`	`setGlobal(boolean isGlobal)` Sets whether the alert target is a global target and will receive notifications triggered for any alert group.
`void`	`setNotificationType(String notificationType)`
`void`	`setProperties(String properties)`
`void`	`setTargetId(Long targetId)` Sets the unique ID of this alert target.
`void`	`setTargetName(String targetName)` Sets the name of this alert target.
`String`	`toString()`

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

- Constructor Detail
  - AlertTargetEntity
```
public AlertTargetEntity()
```
- Method Detail
  - getTargetId
```
public Long getTargetId()
```
    Gets the unique ID of this alert target.
    
    Returns:
    
    the ID of the target (never null).
  - setTargetId
```
public void setTargetId(Long targetId)
```
    Sets the unique ID of this alert target.
    
    Parameters:
    
    targetId - the ID of the alert target (not null).
  - getDescription
```
public String getDescription()
```
    Gets the description of this alert target.
    
    Returns:
    
    the description or null if none.
  - setDescription
```
public void setDescription(String description)
```
    Sets the description for this alert target.
    
    Parameters:
    
    description - the description or null for none.
  - getNotificationType
```
public String getNotificationType()
```
    Returns:
  - setNotificationType
```
public void setNotificationType(String notificationType)
```
    Parameters:
    
    notificationType -
  - getProperties
```
public String getProperties()
```
    Returns:
  - setProperties
```
public void setProperties(String properties)
```
    Parameters:
    
    properties -
  - getTargetName
```
public String getTargetName()
```
    Gets the name of this alert target.
    
    Returns:
    
    the alert target name (never null).
  - isGlobal
```
public boolean isGlobal()
```
    Gets whether the alert target is a global target and will receive notifications triggered for any alert group.
    
    Returns:
    
    the isGlobal if the target is global.
  - setGlobal
```
public void setGlobal(boolean isGlobal)
```
    Sets whether the alert target is a global target and will receive notifications triggered for any alert group.
    
    Parameters:
    
    isGlobal - if the target is global.
  - isEnabled
```
public boolean isEnabled()
```
    Gets whether the alert target is enabled. Targets which are not enabled will not receive notifications.
    
    Returns:
    
    the true if the target is enabled.
  - setEnabled
```
public void setEnabled(boolean isEnabled)
```
    Sets whether the alert target is enabled. Targets which are not enabled will not receive notifications.
    
    Parameters:
    
    isEnabled - if the target is enabled.
  - getAlertStates
```
public Set<AlertState> getAlertStates()
```
    Gets the alert states that will cause a triggered alert to be sent to this target. A target may be associated with a group where an alert has changed state, but if that new state is not of interest to the target, it will not be sent.
    
    Returns:
    
    the set of alert states or null or empty to imply all.
  - setAlertStates
```
public void setAlertStates(Set<AlertState> alertStates)
```
    Sets the alert states that will cause a triggered alert to be sent to this target. A target may be associated with a group where an alert has changed state, but if that new state is not of interest to the target, it will not be sent.
    
    Parameters:
    
    alertStates - the set of alert states or null or empty to imply all.
  - setTargetName
```
public void setTargetName(String targetName)
```
    Sets the name of this alert target.
    
    Parameters:
    
    targetName - the name (not null).
  - getAlertGroups
```
public Set<AlertGroupEntity> getAlertGroups()
```
    Gets an immutable set of the alert groups that this target is associated with.
    
    Returns:
    
    the groups that will send to this target when an alert in that group is received, or an empty set for none.
  - setAlertGroups
```
public void setAlertGroups(Set<AlertGroupEntity> alertGroups)
```
    Sets all of the groups that are associated with this target.
    
    Parameters:
    
    alertGroups - the groups, or null if there are none.
  - addAlertGroup
```
protected void addAlertGroup(AlertGroupEntity alertGroup)
```
    Adds the specified alert group to the groups that this target 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 target is associated with. This is used to complement the JPA bidirectional association.
    
    Parameters:
    
    alertGroup -
  - addAlertNotice
```
protected void addAlertNotice(AlertNoticeEntity notice)
```
    Adds the specified notice to the notices that have been sent out for this target.
    
    Parameters:
    
    notice - the notice.
  - getAlertNotices
```
public List<AlertNoticeEntity> getAlertNotices()
```
  - setAlertNotices
```
public void setAlertNotices(List<AlertNoticeEntity> alertNotices)
```
  - preRemove
```
public void preRemove()
```
    Called before EntityManager.remove(Object) for this entity, removes the non-owning relationship between targets and groups.
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AlertTargetEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlertTargetEntity

Method Detail

getTargetId

setTargetId

getDescription

setDescription

getNotificationType

setNotificationType

getProperties

setProperties

getTargetName

isGlobal

setGlobal

isEnabled

setEnabled

getAlertStates

setAlertStates

setTargetName

getAlertGroups

setAlertGroups

addAlertGroup

removeAlertGroup

addAlertNotice

getAlertNotices

setAlertNotices

preRemove

equals

hashCode

toString