Class AnomalyDetectorConfiguration

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

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.

See Also:

  • Method Details

    • hasExcludedTimeRanges

      public final boolean hasExcludedTimeRanges()
      For responses, this returns true if the service returned a value for the ExcludedTimeRanges 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.

    • excludedTimeRanges

      public final List<Range> excludedTimeRanges()

      An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates the 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 hasExcludedTimeRanges() method.

      Returns:
      An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates the model.

    • metricTimezone

      public final String metricTimezone()

      The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.

      To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database.

      Returns:
      The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.

      To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database.

    • adaptationSpeed

      public final AnomalyDetectorAdaptationSpeed adaptationSpeed()

      The speed at which the anomaly detection model adapts to sustained changes in the metric's baseline. Faster adaptation lets the model track shifting workloads sooner, but increases the chance that the model treats a real, lasting change as normal.

      Valid values:

      • FAST - The model adapts quickly to sustained changes in the baseline.

      • NORMAL - The model adapts at a moderate pace. This is the default value.

      • SLOW - The model adapts slowly, reducing the risk of treating a real change as normal.

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

      Returns:
      The speed at which the anomaly detection model adapts to sustained changes in the metric's baseline. Faster adaptation lets the model track shifting workloads sooner, but increases the chance that the model treats a real, lasting change as normal.

      Valid values:

      • FAST - The model adapts quickly to sustained changes in the baseline.

      • NORMAL - The model adapts at a moderate pace. This is the default value.

      • SLOW - The model adapts slowly, reducing the risk of treating a real change as normal.

      See Also:

    • adaptationSpeedAsString

      public final String adaptationSpeedAsString()

      The speed at which the anomaly detection model adapts to sustained changes in the metric's baseline. Faster adaptation lets the model track shifting workloads sooner, but increases the chance that the model treats a real, lasting change as normal.

      Valid values:

      • FAST - The model adapts quickly to sustained changes in the baseline.

      • NORMAL - The model adapts at a moderate pace. This is the default value.

      • SLOW - The model adapts slowly, reducing the risk of treating a real change as normal.

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

      Returns:
      The speed at which the anomaly detection model adapts to sustained changes in the metric's baseline. Faster adaptation lets the model track shifting workloads sooner, but increases the chance that the model treats a real, lasting change as normal.

      Valid values:

      • FAST - The model adapts quickly to sustained changes in the baseline.

      • NORMAL - The model adapts at a moderate pace. This is the default value.

      • SLOW - The model adapts slowly, reducing the risk of treating a real change as normal.

      See Also:

    • outlierFilteringStrength

      public final AnomalyDetectorOutlierFilteringStrength outlierFilteringStrength()

      The aggressiveness with which CloudWatch filters outliers from the metric data that the anomaly detection model uses. Stronger filtering excludes more extreme values, which can produce a tighter band of expected values but may also suppress legitimate spikes.

      Valid values:

      • MINIMAL - Excludes only the most extreme outliers.

      • MODERATE - Excludes a moderate range of outliers. This is the default value.

      • STRICT - Excludes a wider range of outliers, which can suppress legitimate spikes.

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

      Returns:
      The aggressiveness with which CloudWatch filters outliers from the metric data that the anomaly detection model uses. Stronger filtering excludes more extreme values, which can produce a tighter band of expected values but may also suppress legitimate spikes.

      Valid values:

      • MINIMAL - Excludes only the most extreme outliers.

      • MODERATE - Excludes a moderate range of outliers. This is the default value.

      • STRICT - Excludes a wider range of outliers, which can suppress legitimate spikes.

      See Also:

    • outlierFilteringStrengthAsString

      public final String outlierFilteringStrengthAsString()

      The aggressiveness with which CloudWatch filters outliers from the metric data that the anomaly detection model uses. Stronger filtering excludes more extreme values, which can produce a tighter band of expected values but may also suppress legitimate spikes.

      Valid values:

      • MINIMAL - Excludes only the most extreme outliers.

      • MODERATE - Excludes a moderate range of outliers. This is the default value.

      • STRICT - Excludes a wider range of outliers, which can suppress legitimate spikes.

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

      Returns:
      The aggressiveness with which CloudWatch filters outliers from the metric data that the anomaly detection model uses. Stronger filtering excludes more extreme values, which can produce a tighter band of expected values but may also suppress legitimate spikes.

      Valid values:

      • MINIMAL - Excludes only the most extreme outliers.

      • MODERATE - Excludes a moderate range of outliers. This is the default value.

      • STRICT - Excludes a wider range of outliers, which can suppress legitimate spikes.

      See Also:

    • toBuilder

      public AnomalyDetectorConfiguration.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<AnomalyDetectorConfiguration.Builder,AnomalyDetectorConfiguration>
      Returns:
      a builder for type T

    • builder

      public static AnomalyDetectorConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AnomalyDetectorConfiguration.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.