Class ThresholdRuleCondition

java.lang.Object
com.azure.resourcemanager.monitor.models.RuleCondition
com.azure.resourcemanager.monitor.models.ThresholdRuleCondition
All Implemented Interfaces:
com.azure.json.JsonSerializable<RuleCondition>
public final class ThresholdRuleCondition extends RuleCondition
A rule condition based on a metric crossing a threshold.

  • Constructor Details

    • ThresholdRuleCondition

      public ThresholdRuleCondition()
      Creates an instance of ThresholdRuleCondition class.

  • Method Details

    • odataType

      public String odataType()
      Get the odataType property: specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric).
      Overrides:
      odataType in class RuleCondition
      Returns:
      the odataType value.

    • 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.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class RuleCondition
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<RuleCondition>
      Overrides:
      toJson in class RuleCondition
      Throws:
      IOException

    • fromJson

      public static ThresholdRuleCondition fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ThresholdRuleCondition from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ThresholdRuleCondition if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the ThresholdRuleCondition.