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.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AnomalyDetector.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static AnomalyDetector.Builder
builder()
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.List<Dimension>
dimensions()
Deprecated.Use SingleMetricAnomalyDetector.Dimensions property.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasDimensions()
Deprecated.Use SingleMetricAnomalyDetector.Dimensions property.int
hashCode()
MetricMathAnomalyDetector
metricMathAnomalyDetector()
The CloudWatch metric math expression for this anomaly detector.String
metricName()
Deprecated.Use SingleMetricAnomalyDetector.MetricName property.String
namespace()
Deprecated.Use SingleMetricAnomalyDetector.Namespace property.List<SdkField<?>>
sdkFields()
static Class<? extends AnomalyDetector.Builder>
serializableBuilderClass()
SingleMetricAnomalyDetector
singleMetricAnomalyDetector()
The CloudWatch metric and statistic for this anomaly detector.String
stat()
Deprecated.Use SingleMetricAnomalyDetector.Stat property.AnomalyDetectorStateValue
stateValue()
The current status of the anomaly detector's training.String
stateValueAsString()
The current status of the anomaly detector's training.AnomalyDetector.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()
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. 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,
stateValue
will returnAnomalyDetectorStateValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateValueAsString()
.- Returns:
- The current status of the anomaly detector's training. The possible values are
TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
- See Also:
AnomalyDetectorStateValue
-
stateValueAsString
public final String stateValueAsString()
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,
stateValue
will returnAnomalyDetectorStateValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateValueAsString()
.- Returns:
- The current status of the anomaly detector's training. The possible values are
TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
- See Also:
AnomalyDetectorStateValue
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<AnomalyDetector.Builder,AnomalyDetector>
-
builder
public static AnomalyDetector.Builder builder()
-
serializableBuilderClass
public static Class<? extends AnomalyDetector.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-