org.hawkular.alerts.api.model.trigger

Class Trigger

java.lang.Object

org.hawkular.alerts.api.model.trigger.Trigger

public class Trigger
extends Object

A Trigger definition. A Trigger can fire an Alert or an Event.

Author:

Jay Shaughnessy, Lucas Ponce

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	context
protected Map<String,String>	tags

Constructor Summary

Constructors

Constructor and Description
Trigger()
Trigger(String triggerId, String name) This constructor requires the tenantId be assigned prior to persistence.
Trigger(String triggerId, String name, Map<String,String> context) This constructor requires the tenantId be assigned prior to persistence.
Trigger(String tenantId, String id, String name)
Trigger(String tenantId, String id, String name, Map<String,String> context)
Trigger(String tenantId, String id, String name, Map<String,String> context, Map<String,String> tags)

Method Summary

Modifier and Type	Method and Description
void	addAction(String actionPlugin, String actionId)
void	addActions(String actionPlugin, Set<String> actionIds)
void	addContext(String name, String value)
void	addTag(String name, String value)
boolean	equals(Object o)
static String	generateId()
Map<String,Set<String>>	getActions()
Match	getAutoResolveMatch()
Map<String,String>	getContext()
String	getDescription()
String	getEventCategory()
String	getEventText()
EventType	getEventType()
Match	getFiringMatch()
String	getId()
Match	getMatch()
String	getMemberOf()
Mode	getMode()
String	getName()
Severity	getSeverity()
Map<String,String>	getTags()
String	getTenantId()
int	hashCode()
boolean	isAutoDisable()
boolean	isAutoEnable()
boolean	isAutoResolve()
boolean	isAutoResolveAlerts()
boolean	isEnabled()
boolean	isGroup()
boolean	isLoadable()
boolean	isMember()
boolean	isOrphan()
void	removeAction(String actionPlugin, String actionId)
void	setActions(Map<String,Set<String>> actions)
void	setAutoDisable(boolean autoDisable)
void	setAutoEnable(boolean autoEnable)
void	setAutoResolve(boolean autoResolve)
void	setAutoResolveAlerts(boolean autoResolveAlerts)
void	setAutoResolveMatch(Match autoResolveMatch)
void	setContext(Map<String,String> context)
void	setDescription(String description)
void	setEnabled(boolean enabled)
void	setEventCategory(String eventCategory)
void	setEventText(String eventText)
void	setEventType(EventType eventType)
void	setFiringMatch(Match firingMatch)
void	setGroup(boolean group) If true this is a group trigger: non-firing, used to manage a set of member triggers.
void	setId(String id)
void	setMatch(Match match)
void	setMemberOf(String memberOf) The group trigger in which this is a member trigger.
void	setMode(Mode mode)
void	setName(String name)
void	setOrphan(boolean orphan) A member trigger that is not being managed by the group.
void	setSeverity(Severity severity)
void	setTags(Map<String,String> tags)
void	setTenantId(String tenantId)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

context

protected Map<String,String> context

tags

protected Map<String,String> tags

Constructor Detail

Trigger

public Trigger()

Trigger

public Trigger(String triggerId,
               String name)

This constructor requires the tenantId be assigned prior to persistence. It can be used when creating triggers via Rest, as the tenant will be assigned automatically.

Parameters:

triggerId - the triggerId, unique within the tenant.

name - the trigger display name.

Trigger

public Trigger(String triggerId,
               String name,
               Map<String,String> context)

This constructor requires the tenantId be assigned prior to persistence. It can be used when creating triggers via Rest, as the tenant will be assigned automatically.

Parameters:

triggerId - the triggerId, unique within the tenant.

name - the trigger display name.

context - optional context data to be stored with the trigger and assigned to its generated alerts

Trigger

public Trigger(String tenantId,
               String id,
               String name)

Trigger

public Trigger(String tenantId,
               String id,
               String name,
               Map<String,String> context)

Trigger

public Trigger(String tenantId,
               String id,
               String name,
               Map<String,String> context,
               Map<String,String> tags)

Method Detail

generateId

public static String generateId()

getTenantId

public String getTenantId()

setTenantId

public void setTenantId(String tenantId)

getId

public String getId()

setId

public void setId(String id)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getEventType

public EventType getEventType()

setEventType

public void setEventType(EventType eventType)

getEventCategory

public String getEventCategory()

setEventCategory

public void setEventCategory(String eventCategory)

getEventText

public String getEventText()

setEventText

public void setEventText(String eventText)

getContext

public Map<String,String> getContext()

setContext

public void setContext(Map<String,String> context)

addContext

public void addContext(String name,
                       String value)

getTags

public Map<String,String> getTags()

setTags

public void setTags(Map<String,String> tags)

addTag

public void addTag(String name,
                   String value)

isAutoDisable

public boolean isAutoDisable()

setAutoDisable

public void setAutoDisable(boolean autoDisable)

isAutoEnable

public boolean isAutoEnable()

setAutoEnable

public void setAutoEnable(boolean autoEnable)

isAutoResolve

public boolean isAutoResolve()

setAutoResolve

public void setAutoResolve(boolean autoResolve)

isAutoResolveAlerts

public boolean isAutoResolveAlerts()

setAutoResolveAlerts

public void setAutoResolveAlerts(boolean autoResolveAlerts)

getSeverity

public Severity getSeverity()

setSeverity

public void setSeverity(Severity severity)

getFiringMatch

public Match getFiringMatch()

getAutoResolveMatch

public Match getAutoResolveMatch()

getActions

public Map<String,Set<String>> getActions()

setActions

public void setActions(Map<String,Set<String>> actions)

addAction

public void addAction(String actionPlugin,
                      String actionId)

addActions

public void addActions(String actionPlugin,
                       Set<String> actionIds)

removeAction

public void removeAction(String actionPlugin,
                         String actionId)

getMemberOf

public String getMemberOf()

setMemberOf

public void setMemberOf(String memberOf)

The group trigger in which this is a member trigger. A trigger can be one of group-level, member-level, or neither.

Parameters:

memberOf - If set, the group-level triggerId.

isGroup

public boolean isGroup()

setGroup

public void setGroup(boolean group)

If true this is a group trigger: non-firing, used to manage a set of member triggers. A trigger can be one of group-level, member-level, or neither.

Parameters:

group - if true this is a group-level trigger.

isMember

public boolean isMember()

isOrphan

public boolean isOrphan()

setOrphan

public void setOrphan(boolean orphan)

A member trigger that is not being managed by the group. It maintains it's group trigger reference and can be un-orphaned.

Parameters:

orphan - true if this is an orphan member trigger.

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isLoadable

public boolean isLoadable()

getMode

public Mode getMode()

setMode

public void setMode(Mode mode)

getMatch

public Match getMatch()

setMatch

public void setMatch(Match match)

setFiringMatch

public void setFiringMatch(Match firingMatch)

setAutoResolveMatch

public void setAutoResolveMatch(Match autoResolveMatch)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object