com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.yml

### YamlMime:JavaType
uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration"
fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration"
name: "MetricAlertConfiguration"
nameWithType: "MetricAlertConfiguration"
summary: "Defines alerting settings for anomalies detected by a detection configuration."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **MetricAlertConfiguration**"
constructors:
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.MetricAlertConfiguration(java.lang.String,com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope)"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.MetricAlertConfiguration(String detectionConfigurationId, MetricAnomalyAlertScope alertScope)"
  name: "MetricAlertConfiguration(String detectionConfigurationId, MetricAnomalyAlertScope alertScope)"
  nameWithType: "MetricAlertConfiguration.MetricAlertConfiguration(String detectionConfigurationId, MetricAnomalyAlertScope alertScope)"
  summary: "Creates a new instance of Metric<wbr>Alert<wbr>Configuration."
  parameters:
  - description: "The anomaly detection configuration id."
    name: "detectionConfigurationId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The scope for the alert."
    name: "alertScope"
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope?alt=com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope&text=MetricAnomalyAlertScope\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public MetricAlertConfiguration(String detectionConfigurationId, MetricAnomalyAlertScope alertScope)"
  desc: "Creates a new instance of MetricAlertConfiguration."
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.MetricAlertConfiguration(java.lang.String,com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope,boolean)"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.MetricAlertConfiguration(String detectionConfigurationId, MetricAnomalyAlertScope alertScope, boolean negationOperation)"
  name: "MetricAlertConfiguration(String detectionConfigurationId, MetricAnomalyAlertScope alertScope, boolean negationOperation)"
  nameWithType: "MetricAlertConfiguration.MetricAlertConfiguration(String detectionConfigurationId, MetricAnomalyAlertScope alertScope, boolean negationOperation)"
  summary: "Creates a new instance of Metric<wbr>Alert<wbr>Configuration."
  parameters:
  - description: "The anomaly detection configuration id."
    name: "detectionConfigurationId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The scope for the alert."
    name: "alertScope"
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope?alt=com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope&text=MetricAnomalyAlertScope\" data-throw-if-not-resolved=\"False\" />"
  - description: "if true anomalies in this configuration will not be included in alerts,\n     instead result of applying the configuration become an expression to take part in the operation\n     performed among corresponding series in other configurations. The result of expression is true\n     only if there is no anomaly found in the series."
    name: "negationOperation"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public MetricAlertConfiguration(String detectionConfigurationId, MetricAnomalyAlertScope alertScope, boolean negationOperation)"
  desc: "Creates a new instance of MetricAlertConfiguration."
methods:
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.getAlertConditions()"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.getAlertConditions()"
  name: "getAlertConditions()"
  nameWithType: "MetricAlertConfiguration.getAlertConditions()"
  summary: "Gets the conditions applied on the detected anomalies to decide whether it should be included in the alert or not."
  syntax: "public MetricAnomalyAlertConditions getAlertConditions()"
  desc: "Gets the conditions applied on the detected anomalies to decide whether it should be included in the alert or not."
  returns:
    description: "The alert conditions."
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertConditions?alt=com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertConditions&text=MetricAnomalyAlertConditions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.getAlertScope()"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.getAlertScope()"
  name: "getAlertScope()"
  nameWithType: "MetricAlertConfiguration.getAlertScope()"
  summary: "Gets the alert scope."
  syntax: "public MetricAnomalyAlertScope getAlertScope()"
  desc: "Gets the alert scope."
  returns:
    description: "The alert scope."
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope?alt=com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope&text=MetricAnomalyAlertScope\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.getAlertSnoozeCondition()"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.getAlertSnoozeCondition()"
  name: "getAlertSnoozeCondition()"
  nameWithType: "MetricAlertConfiguration.getAlertSnoozeCondition()"
  summary: "Gets the condition to snooze the inclusion of anomalies in the upcoming alerts."
  syntax: "public MetricAnomalyAlertSnoozeCondition getAlertSnoozeCondition()"
  desc: "Gets the condition to snooze the inclusion of anomalies in the upcoming alerts."
  returns:
    description: "The snooze condition."
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertSnoozeCondition?alt=com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertSnoozeCondition&text=MetricAnomalyAlertSnoozeCondition\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.getDetectionConfigurationId()"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.getDetectionConfigurationId()"
  name: "getDetectionConfigurationId()"
  nameWithType: "MetricAlertConfiguration.getDetectionConfigurationId()"
  summary: "Gets the anomaly detection configuration id."
  syntax: "public String getDetectionConfigurationId()"
  desc: "Gets the anomaly detection configuration id."
  returns:
    description: "The detection configuration id."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.isNegationOperationEnabled()"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.isNegationOperationEnabled()"
  name: "isNegationOperationEnabled()"
  nameWithType: "MetricAlertConfiguration.isNegationOperationEnabled()"
  summary: "True if this configuration is used only as an expression to take part in the operation performed among corresponding series in other configurations."
  syntax: "public Boolean isNegationOperationEnabled()"
  desc: "True if this configuration is used only as an expression to take part in the operation performed among corresponding series in other configurations."
  returns:
    description: "The negation operation value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.setAlertConditions(com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertConditions)"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.setAlertConditions(MetricAnomalyAlertConditions alertConditions)"
  name: "setAlertConditions(MetricAnomalyAlertConditions alertConditions)"
  nameWithType: "MetricAlertConfiguration.setAlertConditions(MetricAnomalyAlertConditions alertConditions)"
  summary: "Sets the conditions to be applied on the detected anomalies to decide whether it should be included in the alert or not."
  parameters:
  - description: "The alert conditions."
    name: "alertConditions"
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertConditions?alt=com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertConditions&text=MetricAnomalyAlertConditions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public MetricAlertConfiguration setAlertConditions(MetricAnomalyAlertConditions alertConditions)"
  desc: "Sets the conditions to be applied on the detected anomalies to decide whether it should be included in the alert or not."
  returns:
    description: "The MetricAlertConfiguration object itself."
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration?alt=com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration&text=MetricAlertConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.setAlertSnoozeCondition(com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertSnoozeCondition)"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.setAlertSnoozeCondition(MetricAnomalyAlertSnoozeCondition snoozeCondition)"
  name: "setAlertSnoozeCondition(MetricAnomalyAlertSnoozeCondition snoozeCondition)"
  nameWithType: "MetricAlertConfiguration.setAlertSnoozeCondition(MetricAnomalyAlertSnoozeCondition snoozeCondition)"
  summary: "Sets the snooze condition."
  parameters:
  - description: "The snooze condition."
    name: "snoozeCondition"
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertSnoozeCondition?alt=com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertSnoozeCondition&text=MetricAnomalyAlertSnoozeCondition\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public MetricAlertConfiguration setAlertSnoozeCondition(MetricAnomalyAlertSnoozeCondition snoozeCondition)"
  desc: "Sets the snooze condition. Once anomalies are alerted, this condition will be used to snooze the inclusion of anomalies in upcoming alerts."
  returns:
    description: "The MetricAlertConfiguration object itself."
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration?alt=com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration&text=MetricAlertConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.setNegationOperation(boolean)"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.setNegationOperation(boolean negationOperation)"
  name: "setNegationOperation(boolean negationOperation)"
  nameWithType: "MetricAlertConfiguration.setNegationOperation(boolean negationOperation)"
  summary: "Sets the negation value."
  parameters:
  - description: "The negation operation value."
    name: "negationOperation"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public MetricAlertConfiguration setNegationOperation(boolean negationOperation)"
  desc: "Sets the negation value. if true anomalies in this configuration will not be included in alerts, instead result of applying the configuration become an expression to take part in the operation performed among corresponding series in other configurations. The result of expression is true only if there is no anomaly found in the series."
  returns:
    description: "The MetricAlertConfiguration object itself."
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration?alt=com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration&text=MetricAlertConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.setScopeOfAlertTo(com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope)"
  fullName: "com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration.setScopeOfAlertTo(MetricAnomalyAlertScope alertScope)"
  name: "setScopeOfAlertTo(MetricAnomalyAlertScope alertScope)"
  nameWithType: "MetricAlertConfiguration.setScopeOfAlertTo(MetricAnomalyAlertScope alertScope)"
  summary: "Sets the alert scope."
  parameters:
  - description: "The alert scope."
    name: "alertScope"
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope?alt=com.azure.ai.metricsadvisor.administration.models.MetricAnomalyAlertScope&text=MetricAnomalyAlertScope\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public MetricAlertConfiguration setScopeOfAlertTo(MetricAnomalyAlertScope alertScope)"
  desc: "Sets the alert scope."
  returns:
    description: "The MetricAlertConfiguration object itself."
    type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration?alt=com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration&text=MetricAlertConfiguration\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines alerting settings for anomalies detected by a detection configuration."
metadata: {}
package: "com.azure.ai.metricsadvisor.administration.models"
artifact: com.azure:azure-ai-metricsadvisor:1.1.26