Alert (secops-beam 0.19.2 API)

java.lang.Object
- com.mozilla.secops.alert.Alert

All Implemented Interfaces:

Serializable
```
public class Alert
extends Object
implements Serializable
```
Global standardized class representing alerting output from pipelines

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Alert.AlertSeverity

Nested Classes
Modifier and Type	Class and Description
`static class`	`Alert.AlertSeverity`

Constructor Summary

Constructors
Constructor and Description

Alert()
Construct new alert object

Constructors
Constructor and Description
`Alert()` Construct new alert object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCustomMetadata(String key, String value)` Set a custom metadata value
`boolean`	`addMetadata(AlertMeta.Key key, List<String> value)` Add metadata as a list of values
`boolean`	`addMetadata(AlertMeta.Key key, String value)` Add metadata
`void`	`addToPayload(String line)` Add new line to payload buffer
`String`	`assemblePayload()` Assemble a complete payload buffer that contains alert metadata information in addition to the alert payload.
`boolean`	`equals(Object o)`
`static Alert`	`fromJSON(String input)` Return `Alert` from JSON string
`static Alert`	`fromJSON(String input, com.fasterxml.jackson.databind.ObjectMapper mapper)` Return `Alert` from JSON string
`HashMap<String,Object>`	`generateTemplateVariables()` Return HashMap used by Freemarker to generate an HTML alert email
`UUID`	`getAlertId()` Returns unique alert ID for this alert.
`String`	`getCategory()` Get alert category
`String`	`getCustomMetadataValue(String key)` Return a custom metadata value
`String`	`getEmailTemplate()` Get email template name
`ArrayList<AlertMeta>`	`getMetadata()` Get alert metadata
`String`	`getMetadataValue(AlertMeta.Key key)` Return a specific metadata value
`String`	`getNotifyMergeKey()` Get alert merge key for notifications from metadata
`String`	`getPayload()` Get alert payload
`Alert.AlertSeverity`	`getSeverity()` Get alert severity
`String`	`getSlackCatchallTemplate()` Get slack catchall template name
`String`	`getSlackTemplate()` Get slack template name
`String`	`getSubcategory()` Get alert subcategory
`String`	`getSummary()` Get alert summary
`org.joda.time.DateTime`	`getTimestamp()` Get alert timestamp
`Boolean`	`hasCorrectFields()` Determine if an alert has all mandatory fields set correctly
`int`	`hashCode()`
`void`	`setAlertId(UUID alertId)` Override generated unique ID for alert
`void`	`setCategory(String category)` Set alert category
`void`	`setEmailTemplate(String templateName)` Set email template name
`void`	`setMetadata(ArrayList<AlertMeta> metadata)` Set alert metadata
`boolean`	`setMetadataValue(AlertMeta.Key key, String value)` Change an existing metadata value
`void`	`setNotifyMergeKey(String key)` Set alert merge key for notifications in metadata
`void`	`setSeverity(Alert.AlertSeverity severity)` Set alert severity
`void`	`setSlackCatchallTemplate(String templateName)` Set slack catchall template name
`void`	`setSlackTemplate(String templateName)` Set slack template name
`void`	`setSubcategory(String subcategory)` Set alert subcategory
`void`	`setSummary(String summary)` Set alert summary
`void`	`setTimestamp(org.joda.time.DateTime timestamp)` Override alert timestamp
`String`	`toJSON()` Return JSON string representation.

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

- Constructor Detail
  - Alert
```
public Alert()
```
    Construct new alert object
- Method Detail
  - hasCorrectFields
```
public Boolean hasCorrectFields()
```
    Determine if an alert has all mandatory fields set correctly
    Pipelines should call this on any Alert object that is going to be submitted to ensure it will not be dropped by the output transforms.
    
    Returns:
    
    True if alert has correct fields
  - assemblePayload
```
public String assemblePayload()
```
    Assemble a complete payload buffer that contains alert metadata information in addition to the alert payload.
    
    Returns:
    
    Assembled payload string
  - setSummary
```
public void setSummary(String summary)
```
    Set alert summary
    
    Parameters:
    
    summary - Alert summary string
  - getSummary
```
public String getSummary()
```
    Get alert summary
    
    Returns:
    
    Summary string
  - setNotifyMergeKey
```
public void setNotifyMergeKey(String key)
```
    Set alert merge key for notifications in metadata
    If a merge key is set in metadata for an alert, some output transforms will utilize this key to group any other alerts with the same key together to minimize generation of similar/duplicate alerts.
    
    Parameters:
    
    key - Merge key for alert notifications
  - getNotifyMergeKey
```
public String getNotifyMergeKey()
```
    Get alert merge key for notifications from metadata
    
    Returns:
    
    Merge key for alert notifications
  - setSeverity
```
public void setSeverity(Alert.AlertSeverity severity)
```
    Set alert severity
    
    Parameters:
    
    severity - Severity
  - getSeverity
```
public Alert.AlertSeverity getSeverity()
```
    Get alert severity
    
    Returns:
    
    Severity
  - addToPayload
```
public void addToPayload(String line)
```
    Add new line to payload buffer
    
    Parameters:
    
    line - Line to append to existing payload buffer
  - getPayload
```
public String getPayload()
```
    Get alert payload
    
    Returns:
    
    Payload string
  - getMetadataValue
```
public String getMetadataValue(AlertMeta.Key key)
```
    Return a specific metadata value
    
    Parameters:
    
    key - Key to return data for
    
    Returns:
    
    Value string, null if not found
  - getCustomMetadataValue
```
public String getCustomMetadataValue(String key)
```
    Return a custom metadata value
    Custom metadata includes arbitrary keys that are not standardized, such as keys set in configuration ticks. This method should not be used under normal circumstances.
    
    Parameters:
    
    key - Key to return data for
    
    Returns:
    
    Value string, null if not found
  - setMetadataValue
```
public boolean setMetadataValue(AlertMeta.Key key,
                                String value)
```
    Change an existing metadata value
    If the key does not exist, it will be added. Note that if multiple entries exist with the same key, this method will only change the first encountered.
    
    Parameters:
    
    key - Key to set
    
    value - Value to set for key
    
    Returns:
    
    True if key was successfully set
  - getMetadata
```
public ArrayList<AlertMeta> getMetadata()
```
    Get alert metadata
    
    Returns:
    
    Alert metadata
  - setMetadata
```
public void setMetadata(ArrayList<AlertMeta> metadata)
```
    Set alert metadata
    
    Parameters:
    
    metadata - ArrayList
  - addMetadata
```
public boolean addMetadata(AlertMeta.Key key,
                           String value)
```
    Add metadata
    
    Parameters:
    
    key - Key
    
    value - Value
    
    Returns:
    
    True if key was successfully set
  - addMetadata
```
public boolean addMetadata(AlertMeta.Key key,
                           List<String> value)
```
    Add metadata as a list of values
    Only valid for LIST type fields.
    
    Parameters:
    
    key - Key
    
    value - List
    
    Returns:
    
    True if key was successfully set
  - addCustomMetadata
```
public void addCustomMetadata(String key,
                              String value)
```
    Set a custom metadata value
    Custom metadata includes arbitrary keys that are not standardized, such as keys set in configuration ticks. This method should not be used under normal circumstances.
    
    Parameters:
    
    key - Key to set
    
    value - Value to set
  - setTimestamp
```
public void setTimestamp(org.joda.time.DateTime timestamp)
```
    Override alert timestamp
    
    Parameters:
    
    timestamp - Alert timestamp
  - getTimestamp
```
public org.joda.time.DateTime getTimestamp()
```
    Get alert timestamp
    
    Returns:
    
    Timestamp
  - setCategory
```
public void setCategory(String category)
```
    Set alert category
    
    Parameters:
    
    category - Alert category string
  - getCategory
```
public String getCategory()
```
    Get alert category
    
    Returns:
    
    Category string
  - getSubcategory
```
public String getSubcategory()
```
    Get alert subcategory
    
    Returns:
    
    String, or null if unset
  - setSubcategory
```
public void setSubcategory(String subcategory)
```
    Set alert subcategory
    
    Parameters:
    
    subcategory - Subcategory string
  - setEmailTemplate
```
public void setEmailTemplate(String templateName)
```
    Set email template name
    
    Parameters:
    
    templateName - Freemarker template name with file extension
  - getEmailTemplate
```
public String getEmailTemplate()
```
    Get email template name
    
    Returns:
    
    Freemarker template name with file extension or null if not set.
  - setSlackTemplate
```
public void setSlackTemplate(String templateName)
```
    Set slack template name
    
    Parameters:
    
    templateName - Freemarker template name with file extension
  - getSlackTemplate
```
public String getSlackTemplate()
```
    Get slack template name
    
    Returns:
    
    Freemarker template name with file extension or null if not set.
  - setSlackCatchallTemplate
```
public void setSlackCatchallTemplate(String templateName)
```
    Set slack catchall template name
    
    Parameters:
    
    templateName - Freemarker template name with file extension
  - getSlackCatchallTemplate
```
public String getSlackCatchallTemplate()
```
    Get slack catchall template name
    
    Returns:
    
    Freemarker template name with file extension or null if not set.
  - setAlertId
```
public void setAlertId(UUID alertId)
```
    Override generated unique ID for alert
    
    Parameters:
    
    alertId - Alert ID for alert
  - getAlertId
```
public UUID getAlertId()
```
    Returns unique alert ID for this alert.
    
    Returns:
    
    UUID associated with alert.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - fromJSON
```
public static Alert fromJSON(String input)
```
    Return Alert from JSON string
    
    Parameters:
    
    input - Alert in JSON
    
    Returns:
    
    Alert object or null if deserialization fails.
  - fromJSON
```
public static Alert fromJSON(String input,
                             com.fasterxml.jackson.databind.ObjectMapper mapper)
```
    Return Alert from JSON string
    
    Parameters:
    
    input - Alert in JSON
    
    mapper - ObjectMapper
    
    Returns:
    
    Alert object or null if deserialization fails.
  - toJSON
```
public String toJSON()
```
    Return JSON string representation.
    
    Returns:
    
    String or null if serialization fails.
  - generateTemplateVariables
```
public HashMap<String,Object> generateTemplateVariables()
```
    Return HashMap used by Freemarker to generate an HTML alert email
    
    Returns:
    
    Template data model

Class Alert

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Alert

Method Detail

hasCorrectFields

assemblePayload

setSummary

getSummary

setNotifyMergeKey

getNotifyMergeKey

setSeverity

getSeverity

addToPayload

getPayload

getMetadataValue

getCustomMetadataValue

setMetadataValue

getMetadata

setMetadata

addMetadata

addMetadata

addCustomMetadata

setTimestamp

getTimestamp

setCategory

getCategory

getSubcategory

setSubcategory

setEmailTemplate

getEmailTemplate

setSlackTemplate

getSlackTemplate

setSlackCatchallTemplate

getSlackCatchallTemplate

setAlertId

getAlertId

equals

hashCode

fromJSON

fromJSON

toJSON

generateTemplateVariables