Package software.amazon.awssdk.services.cloudwatch.model

Class AnomalyDetector

java.lang.Object
software.amazon.awssdk.services.cloudwatch.model.AnomalyDetector
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AnomalyDetector.Builder,AnomalyDetector>
@Generated("software.amazon.awssdk:codegen") public final class AnomalyDetector extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AnomalyDetector.Builder,AnomalyDetector>

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.

If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account.

See Also:

  • Method Details

    • namespace

      @Deprecated public final String namespace()
      Deprecated.
      Use SingleMetricAnomalyDetector.Namespace property.

      The namespace of the metric associated with the anomaly detection model.

      Returns:
      The namespace of the metric associated with the anomaly detection model.

    • metricName

      @Deprecated public final String metricName()
      Deprecated.
      Use SingleMetricAnomalyDetector.MetricName property.

      The name of the metric associated with the anomaly detection model.

      Returns:
      The name of the metric associated with the anomaly detection model.

    • hasDimensions

      @Deprecated public final boolean hasDimensions()
      Deprecated.
      Use SingleMetricAnomalyDetector.Dimensions property.
      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 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.

    • dimensions

      @Deprecated public final List<Dimension> dimensions()
      Deprecated.
      Use SingleMetricAnomalyDetector.Dimensions property.

      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 hasDimensions() method.

      Returns:
      The metric dimensions associated with the anomaly detection model.

    • stat

      @Deprecated public final String stat()
      Deprecated.
      Use SingleMetricAnomalyDetector.Stat property.

      The statistic associated with the anomaly detection model.

      Returns:
      The statistic associated with the anomaly detection model.

    • configuration

      public final AnomalyDetectorConfiguration configuration()

      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.

      Returns:
      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.

    • stateValue

      public final AnomalyDetectorStateValue stateValue()

      The current status of the anomaly detector's training.

      If the service returns an enum value that is not available in the current SDK version, stateValue will return AnomalyDetectorStateValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateValueAsString().

      Returns:
      The current status of the anomaly detector's training.
      See Also:

    • stateValueAsString

      public final String stateValueAsString()

      The current status of the anomaly detector's training.

      If the service returns an enum value that is not available in the current SDK version, stateValue will return AnomalyDetectorStateValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateValueAsString().

      Returns:
      The current status of the anomaly detector's training.
      See Also:

    • metricCharacteristics

      public final MetricCharacteristics metricCharacteristics()

      This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.

      Returns:
      This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.

    • singleMetricAnomalyDetector

      public final SingleMetricAnomalyDetector singleMetricAnomalyDetector()

      The CloudWatch metric and statistic for this anomaly detector.

      Returns:
      The CloudWatch metric and statistic for this anomaly detector.

    • metricMathAnomalyDetector

      public final MetricMathAnomalyDetector metricMathAnomalyDetector()

      The CloudWatch metric math expression for this anomaly detector.

      Returns:
      The CloudWatch metric math expression for this anomaly detector.

    • toBuilder

      public AnomalyDetector.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AnomalyDetector.Builder,AnomalyDetector>
      Returns:
      a builder for type T

    • builder

      public static AnomalyDetector.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AnomalyDetector.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.