azure-docs-sdk-java/docs-ref-autogen/com.azure.ai.metricsadvisor...

210 строки
17 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration"
name: "AnomalyAlertConfiguration"
nameWithType: "AnomalyAlertConfiguration"
summary: "Defines anomaly alerting 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 **AnomalyAlertConfiguration**"
constructors:
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.AnomalyAlertConfiguration(java.lang.String)"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.AnomalyAlertConfiguration(String name)"
name: "AnomalyAlertConfiguration(String name)"
nameWithType: "AnomalyAlertConfiguration.AnomalyAlertConfiguration(String name)"
summary: "Create a new instance of Anomaly<wbr>Alert<wbr>Configuration."
parameters:
- description: "The configuration name."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public AnomalyAlertConfiguration(String name)"
desc: "Create a new instance of AnomalyAlertConfiguration."
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.AnomalyAlertConfiguration(java.lang.String,com.azure.ai.metricsadvisor.administration.models.MetricAlertConfigurationsOperator)"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.AnomalyAlertConfiguration(String name, MetricAlertConfigurationsOperator crossMetricsOperator)"
name: "AnomalyAlertConfiguration(String name, MetricAlertConfigurationsOperator crossMetricsOperator)"
nameWithType: "AnomalyAlertConfiguration.AnomalyAlertConfiguration(String name, MetricAlertConfigurationsOperator crossMetricsOperator)"
summary: "Create a new instance of Anomaly<wbr>Alert<wbr>Configuration."
parameters:
- description: "The configuration name."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The logical operator to apply across multiple\n metric level <xref uid=\"com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MetricAlertConfiguration\"></xref> in the alert configuration."
name: "crossMetricsOperator"
type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAlertConfigurationsOperator?alt=com.azure.ai.metricsadvisor.administration.models.MetricAlertConfigurationsOperator&text=MetricAlertConfigurationsOperator\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AnomalyAlertConfiguration(String name, MetricAlertConfigurationsOperator crossMetricsOperator)"
desc: "Create a new instance of AnomalyAlertConfiguration."
methods:
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.addMetricAlertConfiguration(com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration)"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.addMetricAlertConfiguration(MetricAlertConfiguration configuration)"
name: "addMetricAlertConfiguration(MetricAlertConfiguration configuration)"
nameWithType: "AnomalyAlertConfiguration.addMetricAlertConfiguration(MetricAlertConfiguration configuration)"
summary: "Adds a new metric level alert configuration."
parameters:
- description: "The configuration."
name: "configuration"
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\" />"
syntax: "public AnomalyAlertConfiguration addMetricAlertConfiguration(MetricAlertConfiguration configuration)"
desc: "Adds a new metric level alert configuration."
returns:
description: "The AnomalyAlertConfiguration object itself."
type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration?alt=com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration&text=AnomalyAlertConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getCrossMetricsOperator()"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getCrossMetricsOperator()"
name: "getCrossMetricsOperator()"
nameWithType: "AnomalyAlertConfiguration.getCrossMetricsOperator()"
summary: "Gets the logical operator to apply across multiple metric level alert configurations."
syntax: "public MetricAlertConfigurationsOperator getCrossMetricsOperator()"
desc: "Gets the logical operator to apply across multiple metric level alert configurations."
returns:
description: "The cross metric alert configuration operator."
type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAlertConfigurationsOperator?alt=com.azure.ai.metricsadvisor.administration.models.MetricAlertConfigurationsOperator&text=MetricAlertConfigurationsOperator\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getDescription()"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getDescription()"
name: "getDescription()"
nameWithType: "AnomalyAlertConfiguration.getDescription()"
summary: "Gets the alert configuration description."
syntax: "public String getDescription()"
desc: "Gets the alert configuration description."
returns:
description: "The configuration description."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getDimensionsToSplitAlert()"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getDimensionsToSplitAlert()"
name: "getDimensionsToSplitAlert()"
nameWithType: "AnomalyAlertConfiguration.getDimensionsToSplitAlert()"
summary: "Gets the dimensions names used to split a single alert into multiple ones."
syntax: "public List<String> getDimensionsToSplitAlert()"
desc: "Gets the dimensions names used to split a single alert into multiple ones."
returns:
description: "The dimension names."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getHookIdsToAlert()"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getHookIdsToAlert()"
name: "getHookIdsToAlert()"
nameWithType: "AnomalyAlertConfiguration.getHookIdsToAlert()"
summary: "Gets id of all hooks that receives alerts triggered by this configuration."
syntax: "public List<String> getHookIdsToAlert()"
desc: "Gets id of all hooks that receives alerts triggered by this configuration."
returns:
description: "The hook ids."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getId()"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getId()"
name: "getId()"
nameWithType: "AnomalyAlertConfiguration.getId()"
summary: "Gets the alert configuration id."
syntax: "public String getId()"
desc: "Gets the alert configuration id."
returns:
description: "The 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.AnomalyAlertConfiguration.getMetricAlertConfigurations()"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getMetricAlertConfigurations()"
name: "getMetricAlertConfigurations()"
nameWithType: "AnomalyAlertConfiguration.getMetricAlertConfigurations()"
summary: "Gets all metric level alert configurations."
syntax: "public List<MetricAlertConfiguration> getMetricAlertConfigurations()"
desc: "Gets all metric level alert configurations."
returns:
description: "The metric level alert configurations."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<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\" />&gt;"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getName()"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.getName()"
name: "getName()"
nameWithType: "AnomalyAlertConfiguration.getName()"
summary: "Gets the alert configuration name."
syntax: "public String getName()"
desc: "Gets the alert configuration name."
returns:
description: "The configuration name."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.setCrossMetricsOperator(com.azure.ai.metricsadvisor.administration.models.MetricAlertConfigurationsOperator)"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.setCrossMetricsOperator(MetricAlertConfigurationsOperator crossMetricsOperator)"
name: "setCrossMetricsOperator(MetricAlertConfigurationsOperator crossMetricsOperator)"
nameWithType: "AnomalyAlertConfiguration.setCrossMetricsOperator(MetricAlertConfigurationsOperator crossMetricsOperator)"
summary: "Sets the logical operator to apply across across multiple metric level alert configurations."
parameters:
- description: "The cross metric alert configuration operator."
name: "crossMetricsOperator"
type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.MetricAlertConfigurationsOperator?alt=com.azure.ai.metricsadvisor.administration.models.MetricAlertConfigurationsOperator&text=MetricAlertConfigurationsOperator\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AnomalyAlertConfiguration setCrossMetricsOperator(MetricAlertConfigurationsOperator crossMetricsOperator)"
desc: "Sets the logical operator to apply across across multiple metric level alert configurations."
returns:
description: "The AnomalyAlertConfiguration object itself."
type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration?alt=com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration&text=AnomalyAlertConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.setDescription(java.lang.String)"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.setDescription(String description)"
name: "setDescription(String description)"
nameWithType: "AnomalyAlertConfiguration.setDescription(String description)"
summary: "Sets the description for the configuration."
parameters:
- description: "The configuration description."
name: "description"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public AnomalyAlertConfiguration setDescription(String description)"
desc: "Sets the description for the configuration."
returns:
description: "The AnomalyAlertConfiguration object itself."
type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration?alt=com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration&text=AnomalyAlertConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.setDimensionsToSplitAlert(java.util.List<java.lang.String>)"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.setDimensionsToSplitAlert(List<String> dimensions)"
name: "setDimensionsToSplitAlert(List<String> dimensions)"
nameWithType: "AnomalyAlertConfiguration.setDimensionsToSplitAlert(List<String> dimensions)"
summary: "Sets the dimensions names used to split a single alert into multiple ones."
parameters:
- description: "The hook ids."
name: "dimensions"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public AnomalyAlertConfiguration setDimensionsToSplitAlert(List<String> dimensions)"
desc: "Sets the dimensions names used to split a single alert into multiple ones."
returns:
description: "The AnomalyAlertConfiguration object itself."
type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration?alt=com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration&text=AnomalyAlertConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.setHookIdsToAlert(java.util.List<java.lang.String>)"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.setHookIdsToAlert(List<String> hookIds)"
name: "setHookIdsToAlert(List<String> hookIds)"
nameWithType: "AnomalyAlertConfiguration.setHookIdsToAlert(List<String> hookIds)"
summary: "Sets the hooks to receives alerts triggered by this configuration."
parameters:
- description: "The hook ids."
name: "hookIds"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public AnomalyAlertConfiguration setHookIdsToAlert(List<String> hookIds)"
desc: "Sets the hooks to receives alerts triggered by this configuration."
returns:
description: "The AnomalyAlertConfiguration object itself."
type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration?alt=com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration&text=AnomalyAlertConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.setMetricAlertConfigurations(java.util.List<com.azure.ai.metricsadvisor.administration.models.MetricAlertConfiguration>)"
fullName: "com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration.setMetricAlertConfigurations(List<MetricAlertConfiguration> configurations)"
name: "setMetricAlertConfigurations(List<MetricAlertConfiguration> configurations)"
nameWithType: "AnomalyAlertConfiguration.setMetricAlertConfigurations(List<MetricAlertConfiguration> configurations)"
summary: "Sets the metric level alert configurations."
parameters:
- description: "The configuration."
name: "configurations"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<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\" />&gt;"
syntax: "public AnomalyAlertConfiguration setMetricAlertConfigurations(List<MetricAlertConfiguration> configurations)"
desc: "Sets the metric level alert configurations."
returns:
description: "The AnomalyAlertConfiguration object itself."
type: "<xref href=\"com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration?alt=com.azure.ai.metricsadvisor.administration.models.AnomalyAlertConfiguration&text=AnomalyAlertConfiguration\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines anomaly alerting configuration."
metadata: {}
package: "com.azure.ai.metricsadvisor.administration.models"
artifact: com.azure:azure-ai-metricsadvisor:1.2.1