software.amazon.awssdk.services.cloudwatch.model.AnomalyDetector Maven / Gradle / Ivy
Show all versions of cloudwatch Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloudwatch.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You
* can use the model to display a band of expected, normal values when the metric is graphed.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AnomalyDetector implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAMESPACE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Namespace").getter(getter(AnomalyDetector::namespace)).setter(setter(Builder::namespace))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Namespace").build()).build();
private static final SdkField METRIC_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MetricName").getter(getter(AnomalyDetector::metricName)).setter(setter(Builder::metricName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricName").build()).build();
private static final SdkField> DIMENSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Dimensions")
.getter(getter(AnomalyDetector::dimensions))
.setter(setter(Builder::dimensions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Dimensions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Dimension::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField STAT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Stat")
.getter(getter(AnomalyDetector::stat)).setter(setter(Builder::stat))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Stat").build()).build();
private static final SdkField CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Configuration")
.getter(getter(AnomalyDetector::configuration)).setter(setter(Builder::configuration))
.constructor(AnomalyDetectorConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Configuration").build()).build();
private static final SdkField STATE_VALUE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StateValue").getter(getter(AnomalyDetector::stateValueAsString)).setter(setter(Builder::stateValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StateValue").build()).build();
private static final SdkField SINGLE_METRIC_ANOMALY_DETECTOR_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("SingleMetricAnomalyDetector")
.getter(getter(AnomalyDetector::singleMetricAnomalyDetector))
.setter(setter(Builder::singleMetricAnomalyDetector))
.constructor(SingleMetricAnomalyDetector::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SingleMetricAnomalyDetector")
.build()).build();
private static final SdkField METRIC_MATH_ANOMALY_DETECTOR_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("MetricMathAnomalyDetector")
.getter(getter(AnomalyDetector::metricMathAnomalyDetector)).setter(setter(Builder::metricMathAnomalyDetector))
.constructor(MetricMathAnomalyDetector::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricMathAnomalyDetector").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAMESPACE_FIELD,
METRIC_NAME_FIELD, DIMENSIONS_FIELD, STAT_FIELD, CONFIGURATION_FIELD, STATE_VALUE_FIELD,
SINGLE_METRIC_ANOMALY_DETECTOR_FIELD, METRIC_MATH_ANOMALY_DETECTOR_FIELD));
private static final long serialVersionUID = 1L;
private final String namespace;
private final String metricName;
private final List dimensions;
private final String stat;
private final AnomalyDetectorConfiguration configuration;
private final String stateValue;
private final SingleMetricAnomalyDetector singleMetricAnomalyDetector;
private final MetricMathAnomalyDetector metricMathAnomalyDetector;
private AnomalyDetector(BuilderImpl builder) {
this.namespace = builder.namespace;
this.metricName = builder.metricName;
this.dimensions = builder.dimensions;
this.stat = builder.stat;
this.configuration = builder.configuration;
this.stateValue = builder.stateValue;
this.singleMetricAnomalyDetector = builder.singleMetricAnomalyDetector;
this.metricMathAnomalyDetector = builder.metricMathAnomalyDetector;
}
/**
*
* The namespace of the metric associated with the anomaly detection model.
*
*
* @return The namespace of the metric associated with the anomaly detection model.
* @deprecated Use SingleMetricAnomalyDetector.Namespace property.
*/
@Deprecated
public final String namespace() {
return namespace;
}
/**
*
* The name of the metric associated with the anomaly detection model.
*
*
* @return The name of the metric associated with the anomaly detection model.
* @deprecated Use SingleMetricAnomalyDetector.MetricName property.
*/
@Deprecated
public final String metricName() {
return metricName;
}
/**
* For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*
* @deprecated Use SingleMetricAnomalyDetector.Dimensions property.
*/
@Deprecated
public final boolean hasDimensions() {
return dimensions != null && !(dimensions instanceof SdkAutoConstructList);
}
/**
*
* The metric dimensions associated with the anomaly detection model.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasDimensions} method.
*
*
* @return The metric dimensions associated with the anomaly detection model.
* @deprecated Use SingleMetricAnomalyDetector.Dimensions property.
*/
@Deprecated
public final List dimensions() {
return dimensions;
}
/**
*
* The statistic associated with the anomaly detection model.
*
*
* @return The statistic associated with the anomaly detection model.
* @deprecated Use SingleMetricAnomalyDetector.Stat property.
*/
@Deprecated
public final String stat() {
return stat;
}
/**
*
* The configuration specifies details about how the anomaly detection model is to be trained, including time ranges
* to exclude from use for training the model, and the time zone to use for the metric.
*
*
* @return The configuration specifies details about how the anomaly detection model is to be trained, including
* time ranges to exclude from use for training the model, and the time zone to use for the metric.
*/
public final AnomalyDetectorConfiguration configuration() {
return configuration;
}
/**
*
* The current status of the anomaly detector's training. The possible values are
* TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #stateValue} will
* return {@link AnomalyDetectorStateValue#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #stateValueAsString}.
*
*
* @return The current status of the anomaly detector's training. The possible values are
* TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
* @see AnomalyDetectorStateValue
*/
public final AnomalyDetectorStateValue stateValue() {
return AnomalyDetectorStateValue.fromValue(stateValue);
}
/**
*
* The current status of the anomaly detector's training. The possible values are
* TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #stateValue} will
* return {@link AnomalyDetectorStateValue#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #stateValueAsString}.
*
*
* @return The current status of the anomaly detector's training. The possible values are
* TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
* @see AnomalyDetectorStateValue
*/
public final String stateValueAsString() {
return stateValue;
}
/**
*
* The CloudWatch metric and statistic for this anomaly detector.
*
*
* @return The CloudWatch metric and statistic for this anomaly detector.
*/
public final SingleMetricAnomalyDetector singleMetricAnomalyDetector() {
return singleMetricAnomalyDetector;
}
/**
*
* The CloudWatch metric math expression for this anomaly detector.
*
*
* @return The CloudWatch metric math expression for this anomaly detector.
*/
public final MetricMathAnomalyDetector metricMathAnomalyDetector() {
return metricMathAnomalyDetector;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(namespace());
hashCode = 31 * hashCode + Objects.hashCode(metricName());
hashCode = 31 * hashCode + Objects.hashCode(hasDimensions() ? dimensions() : null);
hashCode = 31 * hashCode + Objects.hashCode(stat());
hashCode = 31 * hashCode + Objects.hashCode(configuration());
hashCode = 31 * hashCode + Objects.hashCode(stateValueAsString());
hashCode = 31 * hashCode + Objects.hashCode(singleMetricAnomalyDetector());
hashCode = 31 * hashCode + Objects.hashCode(metricMathAnomalyDetector());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AnomalyDetector)) {
return false;
}
AnomalyDetector other = (AnomalyDetector) obj;
return Objects.equals(namespace(), other.namespace()) && Objects.equals(metricName(), other.metricName())
&& hasDimensions() == other.hasDimensions() && Objects.equals(dimensions(), other.dimensions())
&& Objects.equals(stat(), other.stat()) && Objects.equals(configuration(), other.configuration())
&& Objects.equals(stateValueAsString(), other.stateValueAsString())
&& Objects.equals(singleMetricAnomalyDetector(), other.singleMetricAnomalyDetector())
&& Objects.equals(metricMathAnomalyDetector(), other.metricMathAnomalyDetector());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("AnomalyDetector").add("Namespace", namespace()).add("MetricName", metricName())
.add("Dimensions", hasDimensions() ? dimensions() : null).add("Stat", stat())
.add("Configuration", configuration()).add("StateValue", stateValueAsString())
.add("SingleMetricAnomalyDetector", singleMetricAnomalyDetector())
.add("MetricMathAnomalyDetector", metricMathAnomalyDetector()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Namespace":
return Optional.ofNullable(clazz.cast(namespace()));
case "MetricName":
return Optional.ofNullable(clazz.cast(metricName()));
case "Dimensions":
return Optional.ofNullable(clazz.cast(dimensions()));
case "Stat":
return Optional.ofNullable(clazz.cast(stat()));
case "Configuration":
return Optional.ofNullable(clazz.cast(configuration()));
case "StateValue":
return Optional.ofNullable(clazz.cast(stateValueAsString()));
case "SingleMetricAnomalyDetector":
return Optional.ofNullable(clazz.cast(singleMetricAnomalyDetector()));
case "MetricMathAnomalyDetector":
return Optional.ofNullable(clazz.cast(metricMathAnomalyDetector()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function