Trigger (Hawkular Alerts Api 1.0.0.Final API)

java.lang.Object
- org.hawkular.alerts.api.model.trigger.Trigger

All Implemented Interfaces:

Serializable
```
public class Trigger
extends Object
implements Serializable
```
A Trigger definition. A Trigger can fire an Alert or an Event.

Author:

Jay Shaughnessy, Lucas Ponce

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Map<String,String> context

protected Map<String,String> dataIdMap

protected Map<String,String> tags

Fields
Modifier and Type	Field and Description
`protected Map<String,String>`	`context`
`protected Map<String,String>`	`dataIdMap`
`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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAction(TriggerAction triggerAction)`
`void`	`addContext(String name, String value)`
`void`	`addTag(String name, String value)`
`boolean`	`equals(Object o)`
`static String`	`generateId()`
`Set<TriggerAction>`	`getActions()`
`Match`	`getAutoResolveMatch()`
`Map<String,String>`	`getContext()`
`Map<String,String>`	`getDataIdMap()`
`String`	`getDescription()`
`String`	`getEventCategory()`
`String`	`getEventText()`
`EventType`	`getEventType()`
`Match`	`getFiringMatch()`
`String`	`getId()`
`Match`	`getMatch()`
`String`	`getMemberOf()`
`Mode`	`getMode()`
`String`	`getName()`
`Severity`	`getSeverity()`
`String`	`getSource()`
`Map<String,String>`	`getTags()`
`String`	`getTenantId()`
`TriggerType`	`getType()`
`int`	`hashCode()`
`boolean`	`isAutoDisable()`
`boolean`	`isAutoEnable()`
`boolean`	`isAutoResolve()`
`boolean`	`isAutoResolveAlerts()`
`boolean`	`isEnabled()`
`boolean`	`isGroup()`
`boolean`	`isLoadable()`
`boolean`	`isMember()`
`boolean`	`isOrphan()`
`void`	`setActions(Set<TriggerAction> 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`	`setDataIdMap(Map<String,String> dataIdMap)`
`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`	`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`	`setSeverity(Severity severity)`
`void`	`setSource(String source)` Typically set for DataDriven group triggers but can be set on any trigger to signify that the trigger only operates on data from the specified data source.
`void`	`setTags(Map<String,String> tags)`
`void`	`setTenantId(String tenantId)`
`void`	`setType(TriggerType type)`
`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
```

dataIdMap
```
protected Map<String,String> dataIdMap
```

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 Set<TriggerAction> getActions()

setActions

public void setActions(Set<TriggerAction> actions)

getDataIdMap

public Map<String,String> getDataIdMap()

setDataIdMap

public void setDataIdMap(Map<String,String> dataIdMap)

addAction

public void addAction(TriggerAction triggerAction)

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()
```

getType
```
public TriggerType getType()
```

setType

public void setType(TriggerType type)

getSource
```
public String getSource()
```

setSource
```
public void setSource(String source)
```
Typically set for DataDriven group triggers but can be set on any trigger to signify that the trigger only operates on data from the specified data source.

isMember
```
public boolean isMember()
```

isOrphan
```
public boolean isOrphan()
```

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

Class Trigger

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

context

tags

dataIdMap

Constructor Detail

Trigger

Trigger

Trigger

Trigger

Trigger

Trigger

Method Detail

generateId

getTenantId

setTenantId

getId

setId

getName

setName

getDescription

setDescription

getEventType

setEventType

getEventCategory

setEventCategory

getEventText

setEventText

getContext

setContext

addContext

getTags

setTags

addTag

isAutoDisable

setAutoDisable

isAutoEnable

setAutoEnable

isAutoResolve

setAutoResolve

isAutoResolveAlerts

setAutoResolveAlerts

getSeverity

setSeverity

getFiringMatch

getAutoResolveMatch

getActions

setActions

getDataIdMap

setDataIdMap

addAction

getMemberOf

setMemberOf

isGroup

getType

setType

getSource

setSource

isMember

isOrphan

isEnabled

setEnabled

isLoadable

getMode

setMode

getMatch

setMatch

setFiringMatch

setAutoResolveMatch

equals

hashCode

toString