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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnomalyDetectorConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static AnomalyDetectorConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Range>	excludedTimeRanges()	An array of time ranges to exclude from use when the anomaly detection model is trained.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExcludedTimeRanges()	For responses, this returns true if the service returned a value for the ExcludedTimeRanges property.
int	hashCode()
String	metricTimezone()	The time zone to use for the metric.
List<SdkField<?>>	sdkFields()
static Class<? extends AnomalyDetectorConfiguration.Builder>	serializableBuilderClass()
AnomalyDetectorConfiguration.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

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.

toBuilder

public AnomalyDetectorConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnomalyDetectorConfiguration.Builder,AnomalyDetectorConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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