Interface PutAnomalyDetectorRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudWatchRequest.Builder, CopyableBuilder<PutAnomalyDetectorRequest.Builder,PutAnomalyDetectorRequest>, SdkBuilder<PutAnomalyDetectorRequest.Builder,PutAnomalyDetectorRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutAnomalyDetectorRequest
@Mutable @NotThreadSafe public static interface PutAnomalyDetectorRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<PutAnomalyDetectorRequest.Builder,PutAnomalyDetectorRequest>

  • Method Details

    • namespace

      @Deprecated PutAnomalyDetectorRequest.Builder namespace(String namespace)
      Deprecated.
      Use SingleMetricAnomalyDetector.

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

      Parameters:
      namespace - The namespace of the metric to create the anomaly detection model for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricName

      @Deprecated PutAnomalyDetectorRequest.Builder metricName(String metricName)
      Deprecated.
      Use SingleMetricAnomalyDetector.

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

      Parameters:
      metricName - The name of the metric to create the anomaly detection model for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      @Deprecated PutAnomalyDetectorRequest.Builder dimensions(Collection<Dimension> dimensions)
      Deprecated.
      Use SingleMetricAnomalyDetector.

      The metric dimensions to create the anomaly detection model for.

      Parameters:
      dimensions - The metric dimensions to create the anomaly detection model for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      @Deprecated PutAnomalyDetectorRequest.Builder dimensions(Dimension... dimensions)
      Deprecated.
      Use SingleMetricAnomalyDetector.

      The metric dimensions to create the anomaly detection model for.

      Parameters:
      dimensions - The metric dimensions to create the anomaly detection model for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      @Deprecated PutAnomalyDetectorRequest.Builder dimensions(Consumer<Dimension.Builder>... dimensions)
      Deprecated.
      Use SingleMetricAnomalyDetector.

      The metric dimensions to create the anomaly detection model for.

      This is a convenience method that creates an instance of the Dimension.Builder avoiding the need to create one manually via Dimension.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dimensions(List<Dimension>).

      Parameters:
      dimensions - a consumer that will call methods on Dimension.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stat

      @Deprecated PutAnomalyDetectorRequest.Builder stat(String stat)
      Deprecated.
      Use SingleMetricAnomalyDetector.

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

      Parameters:
      stat - The statistic to use for the metric and the anomaly detection model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      PutAnomalyDetectorRequest.Builder configuration(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      default PutAnomalyDetectorRequest.Builder configuration(Consumer<AnomalyDetectorConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the AnomalyDetectorConfiguration.Builder avoiding the need to create one manually via AnomalyDetectorConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(AnomalyDetectorConfiguration).

      Parameters:
      configuration - a consumer that will call methods on AnomalyDetectorConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metricCharacteristics

      PutAnomalyDetectorRequest.Builder metricCharacteristics(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • metricCharacteristics

      default PutAnomalyDetectorRequest.Builder metricCharacteristics(Consumer<MetricCharacteristics.Builder> 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.

      This is a convenience method that creates an instance of the MetricCharacteristics.Builder avoiding the need to create one manually via MetricCharacteristics.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricCharacteristics(MetricCharacteristics).

      Parameters:
      metricCharacteristics - a consumer that will call methods on MetricCharacteristics.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • singleMetricAnomalyDetector

      PutAnomalyDetectorRequest.Builder singleMetricAnomalyDetector(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • singleMetricAnomalyDetector

      default PutAnomalyDetectorRequest.Builder singleMetricAnomalyDetector(Consumer<SingleMetricAnomalyDetector.Builder> 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.

      This is a convenience method that creates an instance of the SingleMetricAnomalyDetector.Builder avoiding the need to create one manually via SingleMetricAnomalyDetector.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to singleMetricAnomalyDetector(SingleMetricAnomalyDetector).

      Parameters:
      singleMetricAnomalyDetector - a consumer that will call methods on SingleMetricAnomalyDetector.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metricMathAnomalyDetector

      PutAnomalyDetectorRequest.Builder metricMathAnomalyDetector(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • metricMathAnomalyDetector

      default PutAnomalyDetectorRequest.Builder metricMathAnomalyDetector(Consumer<MetricMathAnomalyDetector.Builder> 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.

      This is a convenience method that creates an instance of the MetricMathAnomalyDetector.Builder avoiding the need to create one manually via MetricMathAnomalyDetector.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricMathAnomalyDetector(MetricMathAnomalyDetector).

      Parameters:
      metricMathAnomalyDetector - a consumer that will call methods on MetricMathAnomalyDetector.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      PutAnomalyDetectorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutAnomalyDetectorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.