Package com.azure.ai.metricsadvisor.administration.models

Class AnomalyAlertConfiguration

java.lang.Object
com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration
public final class AnomalyAlertConfiguration extends Object
Defines anomaly alerting configuration.

  • Constructor Details

    • AnomalyAlertConfiguration

      public AnomalyAlertConfiguration(String name)
      Create a new instance of AnomalyAlertConfiguration.
      Parameters:
      name - The configuration name.

    • AnomalyAlertConfiguration

      public AnomalyAlertConfiguration(String name, MetricAlertConfigurationsOperator crossMetricsOperator)
      Create a new instance of AnomalyAlertConfiguration.
      Parameters:
      name - The configuration name.
      crossMetricsOperator - The logical operator to apply across multiple metric level MetricAlertConfiguration in the alert configuration.

  • Method Details

    • getId

      public String getId()
      Gets the alert configuration id.
      Returns:
      The configuration id.

    • getName

      public String getName()
      Gets the alert configuration name.
      Returns:
      The configuration name.

    • getDescription

      public String getDescription()
      Gets the alert configuration description.
      Returns:
      The configuration description.

    • getCrossMetricsOperator

      public MetricAlertConfigurationsOperator getCrossMetricsOperator()
      Gets the logical operator to apply across multiple metric level alert configurations.
      Returns:
      The cross metric alert configuration operator.

    • getMetricAlertConfigurations

      public List<MetricAlertConfiguration> getMetricAlertConfigurations()
      Gets all metric level alert configurations.
      Returns:
      The metric level alert configurations.

    • getHookIdsToAlert

      public List<String> getHookIdsToAlert()
      Gets id of all hooks that receives alerts triggered by this configuration.
      Returns:
      The hook ids.

    • getDimensionsToSplitAlert

      public List<String> getDimensionsToSplitAlert()
      Gets the dimensions names used to split a single alert into multiple ones.
      Returns:
      The dimension names.

    • setDescription

      public AnomalyAlertConfiguration setDescription(String description)
      Sets the description for the configuration.
      Parameters:
      description - The configuration description.
      Returns:
      The AnomalyAlertConfiguration object itself.

    • setCrossMetricsOperator

      public AnomalyAlertConfiguration setCrossMetricsOperator(MetricAlertConfigurationsOperator crossMetricsOperator)
      Sets the logical operator to apply across across multiple metric level alert configurations.
      Parameters:
      crossMetricsOperator - The cross metric alert configuration operator.
      Returns:
      The AnomalyAlertConfiguration object itself.

    • addMetricAlertConfiguration

      public AnomalyAlertConfiguration addMetricAlertConfiguration(MetricAlertConfiguration configuration)
      Adds a new metric level alert configuration.
      Parameters:
      configuration - The configuration.
      Returns:
      The AnomalyAlertConfiguration object itself.

    • setMetricAlertConfigurations

      public AnomalyAlertConfiguration setMetricAlertConfigurations(List<MetricAlertConfiguration> configurations)
      Sets the metric level alert configurations.
      Parameters:
      configurations - The configuration.
      Returns:
      The AnomalyAlertConfiguration object itself.

    • setHookIdsToAlert

      public AnomalyAlertConfiguration setHookIdsToAlert(List<String> hookIds)
      Sets the hooks to receives alerts triggered by this configuration.
      Parameters:
      hookIds - The hook ids.
      Returns:
      The AnomalyAlertConfiguration object itself.

    • setDimensionsToSplitAlert

      public AnomalyAlertConfiguration setDimensionsToSplitAlert(List<String> dimensions)
      Sets the dimensions names used to split a single alert into multiple ones.
      Parameters:
      dimensions - The hook ids.
      Returns:
      The AnomalyAlertConfiguration object itself.