Package com.scaleoutsoftware.digitaltwin.core

Class AlertMessage

java.lang.Object

com.scaleoutsoftware.digitaltwin.core.AlertMessage

public class AlertMessage
extends Object

A message that should be sent to a configured alert provider.

Constructor Summary

Constructors

Constructor	Description
AlertMessage(String title, String severity, String message)	Construct an alert message with a title, severity, and custom message.
AlertMessage(String title, String severity, String message, HashMap<String,String> optProps)	Construct an alert message with a title, severity, and custom message.

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Retrieve the message for this alert message.
HashMap<String,String>	getOptionalTwinInstanceProperties()	Retrieve the optional twin instance properties for this alert message.
String	getSeverity()	Retrieve the severity for this alert message.
String	getTitle()	Retrieve the title for this alert message.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AlertMessage

public AlertMessage(String title,
 String severity,
 String message)

Construct an alert message with a title, severity, and custom message.

Parameters:

title - the title for the alert message.

severity - the severity for this alert.

message - the custom message for this alert.

AlertMessage

public AlertMessage(String title,
 String severity,
 String message,
 HashMap<String,String> optProps)

Construct an alert message with a title, severity, and custom message.

Parameters:

title - the title for the alert message.

severity - the severity for this alert.

message - the custom message for this alert.

optProps - the optional properties that should be sent to the alerting provider.

Method Details

getTitle

public String getTitle()

Retrieve the title for this alert message.

Returns:

the title of this alert message.

getSeverity

public String getSeverity()

Retrieve the severity for this alert message.

Returns:

the severity for this alert message.

getMessage

public String getMessage()

Retrieve the message for this alert message.

Returns:

the message for this alert message.

getOptionalTwinInstanceProperties

public HashMap<String,String> getOptionalTwinInstanceProperties()

Retrieve the optional twin instance properties for this alert message.

Returns:

the optional twin instance properties for this alert message.

toString

public String toString()

Overrides:

toString in class Object