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>

  • Method Details

    • 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()
      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<PutAnomalyDetectorRequest.Builder,PutAnomalyDetectorRequest>
      Specified by:
      toBuilder in class CloudWatchRequest
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.