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

Class PutAnomalyDetectorRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest

software.amazon.awssdk.services.cloudwatch.model.PutAnomalyDetectorRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutAnomalyDetectorRequest.Builder,PutAnomalyDetectorRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutAnomalyDetectorRequest
extends CloudWatchRequest
implements ToCopyableBuilder<PutAnomalyDetectorRequest.Builder,PutAnomalyDetectorRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutAnomalyDetectorRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutAnomalyDetectorRequest.Builder	builder()
AnomalyDetectorConfiguration	configuration()	The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model.
List<Dimension>	dimensions()	Deprecated. Use SingleMetricAnomalyDetector.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensions()	Deprecated. Use SingleMetricAnomalyDetector.
int	hashCode()
MetricCharacteristics	metricCharacteristics()	Use this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models.
MetricMathAnomalyDetector	metricMathAnomalyDetector()	The metric math anomaly detector to be created.
String	metricName()	Deprecated. Use SingleMetricAnomalyDetector.
String	namespace()	Deprecated. Use SingleMetricAnomalyDetector.
List<SdkField<?>>	sdkFields()
static Class<? extends PutAnomalyDetectorRequest.Builder>	serializableBuilderClass()
SingleMetricAnomalyDetector	singleMetricAnomalyDetector()	A single metric anomaly detector to be created.
String	stat()	Deprecated. Use SingleMetricAnomalyDetector.
PutAnomalyDetectorRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

The namespace of the metric to create the anomaly detection model for.

Returns:

The namespace of the metric to create the anomaly detection model for.

metricName

@Deprecated
public final String metricName()

Deprecated.

Use SingleMetricAnomalyDetector.

The name of the metric to create the anomaly detection model for.

Returns:

The name of the metric to create the anomaly detection model for.

hasDimensions

@Deprecated
public final boolean hasDimensions()

Deprecated.

Use SingleMetricAnomalyDetector.

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.

The metric dimensions to create the anomaly detection model for.

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 to create the anomaly detection model for.

stat

@Deprecated
public final String stat()

Deprecated.

Use SingleMetricAnomalyDetector.

The statistic to use for the metric and the anomaly detection model.

Returns:

The statistic to use for the metric and 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 when training and updating the model. You can specify as many as 10 time ranges.

The configuration can also include 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 when training and updating the model. You can specify as many as 10 time ranges.

The configuration can also include the time zone to use for the metric.

metricCharacteristics

public final MetricCharacteristics metricCharacteristics()

Use this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.

Returns:

Use this object to include parameters 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()

A single metric anomaly detector to be created.

When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:

• Dimensions

• MetricName

• Namespace

• Stat

• the MetricMathAnomalyDetector parameters of PutAnomalyDetectorInput

Instead, specify the single metric anomaly detector attributes as part of the property SingleMetricAnomalyDetector.

Returns:

A single metric anomaly detector to be created.

When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:

• Dimensions

• MetricName

• Namespace

• Stat

• the MetricMathAnomalyDetector parameters of PutAnomalyDetectorInput

Instead, specify the single metric anomaly detector attributes as part of the property SingleMetricAnomalyDetector.

metricMathAnomalyDetector

public final MetricMathAnomalyDetector metricMathAnomalyDetector()

The metric math anomaly detector to be created.

When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

• Dimensions

• MetricName

• Namespace

• Stat

• the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput

Instead, specify the metric math anomaly detector attributes as part of the property MetricMathAnomalyDetector.

Returns:

The metric math anomaly detector to be created.

When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

• Dimensions

• MetricName

• Namespace

• Stat

• the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput

Instead, specify the metric math anomaly detector attributes as part of the property MetricMathAnomalyDetector.

toBuilder

public PutAnomalyDetectorRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutAnomalyDetectorRequest.Builder,PutAnomalyDetectorRequest>

Specified by:

toBuilder in class CloudWatchRequest

builder

public static PutAnomalyDetectorRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo