AlertGroupEntity (Ambari Server 3.0.0.0-SNAPSHOT API)

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

```
@Entity
public class AlertGroupEntity
extends Object
```
The AlertGroupEntity class manages the logical groupings of AlertDefinitionEntitys in order to easily define what alerts an AlertTargetEntity should be notified on.

Constructor Summary

Constructors
Constructor and Description

AlertGroupEntity()

Constructors
Constructor and Description
`AlertGroupEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlertDefinition(AlertDefinitionEntity definition)` Adds the specified definition to the definitions that this group will dispatch to.
`void`	`addAlertTarget(AlertTargetEntity alertTarget)` Adds the specified target to the targets that this group will dispatch to.
`boolean`	`equals(Object object)`
`Set<AlertDefinitionEntity>`	`getAlertDefinitions()` Gets all of the alert definitions that are a part of this grouping.
`Set<AlertTargetEntity>`	`getAlertTargets()` Gets an immutable set of the targets that will receive notifications for alert definitions in this group.
`Long`	`getClusterId()` Gets the ID of the cluster that this alert group is a part of.
`Long`	`getGroupId()` Gets the unique ID of this grouping of alerts.
`String`	`getGroupName()` Gets the name of the grouping of alerts.
`String`	`getServiceName()` Gets the name of the service.
`int`	`hashCode()`
`boolean`	`isDefault()` Gets whether this is a default group and is mostly read-only.
`void`	`removeAlertDefinition(AlertDefinitionEntity definition)` Removes the specified definition from the definitions that this group will dispatch to.
`void`	`removeAlertTarget(AlertTargetEntity alertTarget)` Removes the specified target from the targets that this group will dispatch to.
`void`	`setAlertDefinitions(Set<AlertDefinitionEntity> alertDefinitions)` Set all of the alert definitions that are part of this alert group.
`void`	`setAlertTargets(Set<AlertTargetEntity> alertTargets)` Sets all of the targets that will receive notifications for alert definitions in this group.
`void`	`setClusterId(Long clusterId)` Sets the ID of the cluster that this alert group is a part of.
`void`	`setDefault(boolean isDefault)` Sets whether this is a default group and is immutable.
`void`	`setGroupId(Long groupId)` Sets the unique ID of this grouping of alerts.
`void`	`setGroupName(String groupName)` Sets the name of this grouping of alerts.
`void`	`setServiceName(String serviceName)` Set the service name.
`String`	`toString()`

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

- Constructor Detail
  - AlertGroupEntity
```
public AlertGroupEntity()
```
- Method Detail
  - getGroupId
```
public Long getGroupId()
```
    Gets the unique ID of this grouping of alerts.
    
    Returns:
    
    the ID (never null).
  - setGroupId
```
public void setGroupId(Long groupId)
```
    Sets the unique ID of this grouping of alerts.
    
    Parameters:
    
    groupId - the ID (not null).
  - getClusterId
```
public Long getClusterId()
```
    Gets the ID of the cluster that this alert group is a part of.
    
    Returns:
    
    the ID (never null).
  - setClusterId
```
public void setClusterId(Long clusterId)
```
    Sets the ID of the cluster that this alert group is a part of.
    
    Parameters:
    
    clusterId - the ID of the cluster (not null).
  - getGroupName
```
public String getGroupName()
```
    Gets the name of the grouping of alerts. Group names are unique in a given cluster.
    
    Returns:
    
    the group name (never null).
  - setGroupName
```
public void setGroupName(String groupName)
```
    Sets the name of this grouping of alerts. Group names are unique in a given cluster.
    
    Parameters:
    
    groupName - the name of the group (not null).
  - isDefault
```
public boolean isDefault()
```
    Gets whether this is a default group and is mostly read-only. Default groups cannot have their alert definition groupings changed. New alert definitions are automtaically added to the default group that belongs to the service of that definition.
    
    Returns:
    
    true if this is a default group, false otherwise.
  - setDefault
```
public void setDefault(boolean isDefault)
```
    Sets whether this is a default group and is immutable.
    
    Parameters:
    
    isDefault - true to make this group immutable.
  - getServiceName
```
public String getServiceName()
```
    Gets the name of the service. This is only applicable when isDefault() is true.
    
    Returns:
    
    the service that this is the default group for, or null if this is not a default group.
  - setServiceName
```
public void setServiceName(String serviceName)
```
    Set the service name. This is only applicable when isDefault() is true.
    
    Parameters:
    
    serviceName - the service that this is the default group for, or null if this is not a default group.
  - getAlertDefinitions
```
public Set<AlertDefinitionEntity> getAlertDefinitions()
```
    Gets all of the alert definitions that are a part of this grouping.
    
    Returns:
    
    the alert definitions or an empty set if none (never {@code null).
  - setAlertDefinitions
```
public void setAlertDefinitions(Set<AlertDefinitionEntity> alertDefinitions)
```
    Set all of the alert definitions that are part of this alert group.
    
    Parameters:
    
    alertDefinitions - the definitions, or null for none.
  - addAlertDefinition
```
public void addAlertDefinition(AlertDefinitionEntity definition)
```
    Adds the specified definition to the definitions that this group will dispatch to.
    
    Parameters:
    
    definition - the definition to add (not null).
  - removeAlertDefinition
```
public void removeAlertDefinition(AlertDefinitionEntity definition)
```
    Removes the specified definition from the definitions that this group will dispatch to.
    
    Parameters:
    
    definition - the definition to remove (not null).
  - getAlertTargets
```
public Set<AlertTargetEntity> getAlertTargets()
```
    Gets an immutable set of the targets that will receive notifications for alert definitions in this group.
    
    Returns:
    
    the targets that will be dispatch to for alerts in this group, or an empty set if there are none (never null).
  - addAlertTarget
```
public void addAlertTarget(AlertTargetEntity alertTarget)
```
    Adds the specified target to the targets that this group will dispatch to.
    
    Parameters:
    
    alertTarget - the target to add (not null).
  - removeAlertTarget
```
public void removeAlertTarget(AlertTargetEntity alertTarget)
```
    Removes the specified target from the targets that this group will dispatch to.
    
    Parameters:
    
    alertTarget - the target to remove (not null).
  - setAlertTargets
```
public void setAlertTargets(Set<AlertTargetEntity> alertTargets)
```
    Sets all of the targets that will receive notifications for alert definitions in this group.
    
    Parameters:
    
    alertTargets - the targets, or null if there are none.
  - 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 AlertGroupEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlertGroupEntity

Method Detail

getGroupId

setGroupId

getClusterId

setClusterId

getGroupName

setGroupName

isDefault

setDefault

getServiceName

setServiceName

getAlertDefinitions

setAlertDefinitions

addAlertDefinition

removeAlertDefinition

getAlertTargets

addAlertTarget

removeAlertTarget

setAlertTargets

equals

hashCode

toString