Interface MonitorAlertSourceRule

    • Method Detail

      • getProcessingOrder

        Long getProcessingOrder()
        Get the value for ProcessingOrder. (The order in which to process this rule.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getSeverity

        Long getSeverity()
        Get the value for Severity. (The severity of the node) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • isRising

        boolean isRising()
        Get the value for Rising. (If the severity is rising or falling)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getOperatorMessageExpression

        String getOperatorMessageExpression()
        Get the value for OperatorMessageExpression. (Override the operator message expression for the Monitor Alert. The operator message expression. If this is set, then the expression is evaluated, and the result is used as the operator message. If not set, a source specific default is used.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getDelayAmount

        Long getDelayAmount()
        Get the value for DelayAmount. (Amount of time (in time units) that the monitor node must be in this status before the alert is raised.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getDelayUnits

        TimeUnit getDelayUnits()
        Get the value for DelayUnits. (Time units for the amount of time that the monitor node must be in this status before the alert is raised.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setProcessingOrder

        void setProcessingOrder​(Long newProcessingOrder)
        Set the value for ProcessingOrder. (The order in which to process this rule.) This value is mandatory.
        Parameters:
        newProcessingOrder - the new value for ProcessingOrder. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setSeverity

        void setSeverity​(Long newSeverity)
        Set the value for Severity. (The severity of the node) This value is mandatory.
        Parameters:
        newSeverity - the new value for Severity. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setRising

        void setRising​(boolean newRising)
        Set the value for Rising. (If the severity is rising or falling)
        Parameters:
        newRising - the new value for Rising.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setOperatorMessageExpression

        void setOperatorMessageExpression​(String newOperatorMessageExpression)
        Set the value for OperatorMessageExpression. (Override the operator message expression for the Monitor Alert. The operator message expression. If this is set, then the expression is evaluated, and the result is used as the operator message. If not set, a source specific default is used.) This value is optional.
        Parameters:
        newOperatorMessageExpression - the new value for OperatorMessageExpression.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setDelayAmount

        void setDelayAmount​(Long newDelayAmount)
        Set the value for DelayAmount. (Amount of time (in time units) that the monitor node must be in this status before the alert is raised.) This value is mandatory.
        Parameters:
        newDelayAmount - the new value for DelayAmount. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setDelayUnits

        void setDelayUnits​(TimeUnit newDelayUnits)
        Set the value for DelayUnits. (Time units for the amount of time that the monitor node must be in this status before the alert is raised.) This value is mandatory.
        Parameters:
        newDelayUnits - the new value for DelayUnits. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getMonitorAlertSource

        MonitorAlertSource getMonitorAlertSource()
        Get the MonitorAlertSource.
        Returns:
        MonitorAlertSource
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • getAlertEscalation

        AlertEscalation getAlertEscalation()
        Get the AlertEscalation.
        Returns:
        AlertEscalation
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • setAlertEscalation

        void setAlertEscalation​(AlertEscalation newAlertEscalation)
        Set the value for AlertEscalation. This value is optional.
        Parameters:
        newAlertEscalation - is the object to set AlertEscalation to. The escalation channel to use if this rule matches.