com.azure.resourcemanager.monitor.models.DynamicMetricCriteria Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-monitor Show documentation
Show all versions of azure-resourcemanager-monitor Show documentation
This package contains Microsoft Azure Monitor SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.monitor.models;
import com.azure.core.annotation.Fluent;
import com.azure.core.util.CoreUtils;
import com.azure.core.util.logging.ClientLogger;
import com.azure.json.JsonReader;
import com.azure.json.JsonToken;
import com.azure.json.JsonWriter;
import java.io.IOException;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* Criterion for dynamic threshold.
*/
@Fluent
public final class DynamicMetricCriteria extends MultiMetricCriteria {
/*
* Specifies the type of threshold criteria
*/
private CriterionType criterionType = CriterionType.DYNAMIC_THRESHOLD_CRITERION;
/*
* The operator used to compare the metric value against the threshold.
*/
private DynamicThresholdOperator operator;
/*
* The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric
* series pattern.
*/
private DynamicThresholdSensitivity alertSensitivity;
/*
* The minimum number of violations required within the selected lookback time window required to raise an alert.
*/
private DynamicThresholdFailingPeriods failingPeriods;
/*
* Use this option to set the date from which to start learning the metric historical data and calculate the dynamic
* thresholds (in ISO8601 format)
*/
private OffsetDateTime ignoreDataBefore;
/**
* Creates an instance of DynamicMetricCriteria class.
*/
public DynamicMetricCriteria() {
}
/**
* Get the criterionType property: Specifies the type of threshold criteria.
*
* @return the criterionType value.
*/
@Override
public CriterionType criterionType() {
return this.criterionType;
}
/**
* Get the operator property: The operator used to compare the metric value against the threshold.
*
* @return the operator value.
*/
public DynamicThresholdOperator operator() {
return this.operator;
}
/**
* Set the operator property: The operator used to compare the metric value against the threshold.
*
* @param operator the operator value to set.
* @return the DynamicMetricCriteria object itself.
*/
public DynamicMetricCriteria withOperator(DynamicThresholdOperator operator) {
this.operator = operator;
return this;
}
/**
* Get the alertSensitivity property: The extent of deviation required to trigger an alert. This will affect how
* tight the threshold is to the metric series pattern.
*
* @return the alertSensitivity value.
*/
public DynamicThresholdSensitivity alertSensitivity() {
return this.alertSensitivity;
}
/**
* Set the alertSensitivity property: The extent of deviation required to trigger an alert. This will affect how
* tight the threshold is to the metric series pattern.
*
* @param alertSensitivity the alertSensitivity value to set.
* @return the DynamicMetricCriteria object itself.
*/
public DynamicMetricCriteria withAlertSensitivity(DynamicThresholdSensitivity alertSensitivity) {
this.alertSensitivity = alertSensitivity;
return this;
}
/**
* Get the failingPeriods property: The minimum number of violations required within the selected lookback time
* window required to raise an alert.
*
* @return the failingPeriods value.
*/
public DynamicThresholdFailingPeriods failingPeriods() {
return this.failingPeriods;
}
/**
* Set the failingPeriods property: The minimum number of violations required within the selected lookback time
* window required to raise an alert.
*
* @param failingPeriods the failingPeriods value to set.
* @return the DynamicMetricCriteria object itself.
*/
public DynamicMetricCriteria withFailingPeriods(DynamicThresholdFailingPeriods failingPeriods) {
this.failingPeriods = failingPeriods;
return this;
}
/**
* Get the ignoreDataBefore property: Use this option to set the date from which to start learning the metric
* historical data and calculate the dynamic thresholds (in ISO8601 format).
*
* @return the ignoreDataBefore value.
*/
public OffsetDateTime ignoreDataBefore() {
return this.ignoreDataBefore;
}
/**
* Set the ignoreDataBefore property: Use this option to set the date from which to start learning the metric
* historical data and calculate the dynamic thresholds (in ISO8601 format).
*
* @param ignoreDataBefore the ignoreDataBefore value to set.
* @return the DynamicMetricCriteria object itself.
*/
public DynamicMetricCriteria withIgnoreDataBefore(OffsetDateTime ignoreDataBefore) {
this.ignoreDataBefore = ignoreDataBefore;
return this;
}
/**
* {@inheritDoc}
*/
@Override
public DynamicMetricCriteria withName(String name) {
super.withName(name);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public DynamicMetricCriteria withMetricName(String metricName) {
super.withMetricName(metricName);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public DynamicMetricCriteria withMetricNamespace(String metricNamespace) {
super.withMetricNamespace(metricNamespace);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public DynamicMetricCriteria withTimeAggregation(AggregationTypeEnum timeAggregation) {
super.withTimeAggregation(timeAggregation);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public DynamicMetricCriteria withDimensions(List dimensions) {
super.withDimensions(dimensions);
return this;
}
/**
* {@inheritDoc}
*/
@Override
public DynamicMetricCriteria withSkipMetricValidation(Boolean skipMetricValidation) {
super.withSkipMetricValidation(skipMetricValidation);
return this;
}
/**
* Validates the instance.
*
* @throws IllegalArgumentException thrown if the instance is not valid.
*/
@Override
public void validate() {
super.validate();
if (operator() == null) {
throw LOGGER.atError()
.log(new IllegalArgumentException("Missing required property operator in model DynamicMetricCriteria"));
}
if (alertSensitivity() == null) {
throw LOGGER.atError()
.log(new IllegalArgumentException(
"Missing required property alertSensitivity in model DynamicMetricCriteria"));
}
if (failingPeriods() == null) {
throw LOGGER.atError()
.log(new IllegalArgumentException(
"Missing required property failingPeriods in model DynamicMetricCriteria"));
} else {
failingPeriods().validate();
}
}
private static final ClientLogger LOGGER = new ClientLogger(DynamicMetricCriteria.class);
/**
* {@inheritDoc}
*/
@Override
public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
jsonWriter.writeStartObject();
jsonWriter.writeStringField("name", name());
jsonWriter.writeStringField("metricName", metricName());
jsonWriter.writeStringField("timeAggregation", timeAggregation() == null ? null : timeAggregation().toString());
jsonWriter.writeStringField("metricNamespace", metricNamespace());
jsonWriter.writeArrayField("dimensions", dimensions(), (writer, element) -> writer.writeJson(element));
jsonWriter.writeBooleanField("skipMetricValidation", skipMetricValidation());
jsonWriter.writeStringField("operator", this.operator == null ? null : this.operator.toString());
jsonWriter.writeStringField("alertSensitivity",
this.alertSensitivity == null ? null : this.alertSensitivity.toString());
jsonWriter.writeJsonField("failingPeriods", this.failingPeriods);
jsonWriter.writeStringField("criterionType", this.criterionType == null ? null : this.criterionType.toString());
jsonWriter.writeStringField("ignoreDataBefore",
this.ignoreDataBefore == null
? null
: DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(this.ignoreDataBefore));
if (additionalProperties() != null) {
for (Map.Entry additionalProperty : additionalProperties().entrySet()) {
jsonWriter.writeUntypedField(additionalProperty.getKey(), additionalProperty.getValue());
}
}
return jsonWriter.writeEndObject();
}
/**
* Reads an instance of DynamicMetricCriteria from the JsonReader.
*
* @param jsonReader The JsonReader being read.
* @return An instance of DynamicMetricCriteria 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.
* @throws IOException If an error occurs while reading the DynamicMetricCriteria.
*/
public static DynamicMetricCriteria fromJson(JsonReader jsonReader) throws IOException {
return jsonReader.readObject(reader -> {
DynamicMetricCriteria deserializedDynamicMetricCriteria = new DynamicMetricCriteria();
Map additionalProperties = null;
while (reader.nextToken() != JsonToken.END_OBJECT) {
String fieldName = reader.getFieldName();
reader.nextToken();
if ("name".equals(fieldName)) {
deserializedDynamicMetricCriteria.withName(reader.getString());
} else if ("metricName".equals(fieldName)) {
deserializedDynamicMetricCriteria.withMetricName(reader.getString());
} else if ("timeAggregation".equals(fieldName)) {
deserializedDynamicMetricCriteria
.withTimeAggregation(AggregationTypeEnum.fromString(reader.getString()));
} else if ("metricNamespace".equals(fieldName)) {
deserializedDynamicMetricCriteria.withMetricNamespace(reader.getString());
} else if ("dimensions".equals(fieldName)) {
List dimensions = reader.readArray(reader1 -> MetricDimension.fromJson(reader1));
deserializedDynamicMetricCriteria.withDimensions(dimensions);
} else if ("skipMetricValidation".equals(fieldName)) {
deserializedDynamicMetricCriteria
.withSkipMetricValidation(reader.getNullable(JsonReader::getBoolean));
} else if ("operator".equals(fieldName)) {
deserializedDynamicMetricCriteria.operator
= DynamicThresholdOperator.fromString(reader.getString());
} else if ("alertSensitivity".equals(fieldName)) {
deserializedDynamicMetricCriteria.alertSensitivity
= DynamicThresholdSensitivity.fromString(reader.getString());
} else if ("failingPeriods".equals(fieldName)) {
deserializedDynamicMetricCriteria.failingPeriods = DynamicThresholdFailingPeriods.fromJson(reader);
} else if ("criterionType".equals(fieldName)) {
deserializedDynamicMetricCriteria.criterionType = CriterionType.fromString(reader.getString());
} else if ("ignoreDataBefore".equals(fieldName)) {
deserializedDynamicMetricCriteria.ignoreDataBefore = reader
.getNullable(nonNullReader -> CoreUtils.parseBestOffsetDateTime(nonNullReader.getString()));
} else {
if (additionalProperties == null) {
additionalProperties = new LinkedHashMap<>();
}
additionalProperties.put(fieldName, reader.readUntyped());
}
}
deserializedDynamicMetricCriteria.withAdditionalProperties(additionalProperties);
return deserializedDynamicMetricCriteria;
});
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy