Class AnomalyDetector
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AnomalyDetector.Builder
builder()
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.Deprecated.Use SingleMetricAnomalyDetector.Dimensions property.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
Deprecated.Use SingleMetricAnomalyDetector.Dimensions property.final int
hashCode()
The CloudWatch metric math expression for this anomaly detector.final String
Deprecated.Use SingleMetricAnomalyDetector.MetricName property.final String
Deprecated.Use SingleMetricAnomalyDetector.Namespace property.static Class
<? extends AnomalyDetector.Builder> The CloudWatch metric and statistic for this anomaly detector.final String
stat()
Deprecated.Use SingleMetricAnomalyDetector.Stat property.The current status of the anomaly detector's training.final String
The current status of the anomaly detector's training.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.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.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.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.Use SingleMetricAnomalyDetector.Stat property.The statistic associated with the anomaly detection model.
- Returns:
- The statistic associated with the anomaly detection model.
-
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
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:
-
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:
-
singleMetricAnomalyDetector
The CloudWatch metric and statistic for this anomaly detector.
- Returns:
- The CloudWatch metric and statistic for this anomaly detector.
-
metricMathAnomalyDetector
The CloudWatch metric math expression for this anomaly detector.
- Returns:
- The CloudWatch metric math expression for this anomaly detector.
-
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 interfaceToCopyableBuilder<AnomalyDetector.Builder,
AnomalyDetector> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-