Package com.scaleoutsoftware.digitaltwin.core

Class AlertMessage

  • public class AlertMessage
extends java.lang.Object
    A message that should be sent to a configured alert provider.

    • Constructor Summary

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

    • Method Summary

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AlertMessage

        public AlertMessage​(java.lang.String title,
                    java.lang.String severity,
                    java.lang.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​(java.lang.String title,
                    java.lang.String severity,
                    java.lang.String message,
                    java.util.HashMap<java.lang.String,​java.lang.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 Detail

      • getTitle

        public java.lang.String getTitle()
        Retrieve the title for this alert message.
        Returns:
        the title of this alert message.

      • getSeverity

        public java.lang.String getSeverity()
        Retrieve the severity for this alert message.
        Returns:
        the severity for this alert message.

      • getMessage

        public java.lang.String getMessage()
        Retrieve the message for this alert message.
        Returns:
        the message for this alert message.

      • getOptionalTwinInstanceProperties

        public java.util.HashMap<java.lang.String,​java.lang.String> getOptionalTwinInstanceProperties()
        Retrieve the optional twin instance properties for this alert message.
        Returns:
        the optional twin instance properties for this alert message.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object