Class ThresholdRuleCondition


  • public class ThresholdRuleCondition
    extends RuleCondition
    A rule condition based on a metric crossing a threshold.
    • Constructor Detail

      • ThresholdRuleCondition

        public ThresholdRuleCondition()
    • Method Detail

      • operator

        public ConditionOperator operator()
        Get the operator property: the operator used to compare the data and the threshold.
        Returns:
        the operator value.
      • withOperator

        public ThresholdRuleCondition withOperator​(ConditionOperator operator)
        Set the operator property: the operator used to compare the data and the threshold.
        Parameters:
        operator - the operator value to set.
        Returns:
        the ThresholdRuleCondition object itself.
      • threshold

        public double threshold()
        Get the threshold property: the threshold value that activates the alert.
        Returns:
        the threshold value.
      • withThreshold

        public ThresholdRuleCondition withThreshold​(double threshold)
        Set the threshold property: the threshold value that activates the alert.
        Parameters:
        threshold - the threshold value to set.
        Returns:
        the ThresholdRuleCondition object itself.
      • windowSize

        public Duration windowSize()
        Get the windowSize property: the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.
        Returns:
        the windowSize value.
      • withWindowSize

        public ThresholdRuleCondition withWindowSize​(Duration windowSize)
        Set the windowSize property: the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. If specified then it must be between 5 minutes and 1 day.
        Parameters:
        windowSize - the windowSize value to set.
        Returns:
        the ThresholdRuleCondition object itself.
      • timeAggregation

        public TimeAggregationOperator timeAggregation()
        Get the timeAggregation property: the time aggregation operator. How the data that are collected should be combined over time. The default value is the PrimaryAggregationType of the Metric.
        Returns:
        the timeAggregation value.
      • withTimeAggregation

        public ThresholdRuleCondition withTimeAggregation​(TimeAggregationOperator timeAggregation)
        Set the timeAggregation property: the time aggregation operator. How the data that are collected should be combined over time. The default value is the PrimaryAggregationType of the Metric.
        Parameters:
        timeAggregation - the timeAggregation value to set.
        Returns:
        the ThresholdRuleCondition object itself.
      • withDataSource

        public ThresholdRuleCondition withDataSource​(RuleDataSource dataSource)
        Set the dataSource property: the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource.
        Overrides:
        withDataSource in class RuleCondition
        Parameters:
        dataSource - the dataSource value to set.
        Returns:
        the RuleCondition object itself.