com.amazonaws.services.cloudwatch.model.AnomalyDetector Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudwatch Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cloudwatch.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* 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.
*
*
* If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be
* in the same account or a source account.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AnomalyDetector implements Serializable, Cloneable {
/**
*
* The namespace of the metric associated with the anomaly detection model.
*
*/
@Deprecated
private String namespace;
/**
*
* The name of the metric associated with the anomaly detection model.
*
*/
@Deprecated
private String metricName;
/**
*
* The metric dimensions associated with the anomaly detection model.
*
*/
@Deprecated
private com.amazonaws.internal.SdkInternalList dimensions;
/**
*
* The statistic associated with the anomaly detection model.
*
*/
@Deprecated
private String stat;
/**
*
* 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.
*
*/
private AnomalyDetectorConfiguration configuration;
/**
*
* The current status of the anomaly detector's training.
*
*/
private String stateValue;
/**
*
* This object includes parameters that you can use to provide information about your metric to CloudWatch to help
* it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes
* parameter.
*
*/
private MetricCharacteristics metricCharacteristics;
/**
*
* The CloudWatch metric and statistic for this anomaly detector.
*
*/
private SingleMetricAnomalyDetector singleMetricAnomalyDetector;
/**
*
* The CloudWatch metric math expression for this anomaly detector.
*
*/
private MetricMathAnomalyDetector metricMathAnomalyDetector;
/**
*
* The namespace of the metric associated with the anomaly detection model.
*
*
* @param namespace
* The namespace of the metric associated with the anomaly detection model.
*/
@Deprecated
public void setNamespace(String namespace) {
this.namespace = namespace;
}
/**
*
* The namespace of the metric associated with the anomaly detection model.
*
*
* @return The namespace of the metric associated with the anomaly detection model.
*/
@Deprecated
public String getNamespace() {
return this.namespace;
}
/**
*
* The namespace of the metric associated with the anomaly detection model.
*
*
* @param namespace
* The namespace of the metric associated with the anomaly detection model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public AnomalyDetector withNamespace(String namespace) {
setNamespace(namespace);
return this;
}
/**
*
* The name of the metric associated with the anomaly detection model.
*
*
* @param metricName
* The name of the metric associated with the anomaly detection model.
*/
@Deprecated
public void setMetricName(String metricName) {
this.metricName = metricName;
}
/**
*
* The name of the metric associated with the anomaly detection model.
*
*
* @return The name of the metric associated with the anomaly detection model.
*/
@Deprecated
public String getMetricName() {
return this.metricName;
}
/**
*
* The name of the metric associated with the anomaly detection model.
*
*
* @param metricName
* The name of the metric associated with the anomaly detection model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public AnomalyDetector withMetricName(String metricName) {
setMetricName(metricName);
return this;
}
/**
*
* The metric dimensions associated with the anomaly detection model.
*
*
* @return The metric dimensions associated with the anomaly detection model.
*/
@Deprecated
public java.util.List getDimensions() {
if (dimensions == null) {
dimensions = new com.amazonaws.internal.SdkInternalList();
}
return dimensions;
}
/**
*
* The metric dimensions associated with the anomaly detection model.
*
*
* @param dimensions
* The metric dimensions associated with the anomaly detection model.
*/
@Deprecated
public void setDimensions(java.util.Collection dimensions) {
if (dimensions == null) {
this.dimensions = null;
return;
}
this.dimensions = new com.amazonaws.internal.SdkInternalList(dimensions);
}
/**
*
* The metric dimensions associated with the anomaly detection model.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDimensions(java.util.Collection)} or {@link #withDimensions(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param dimensions
* The metric dimensions associated with the anomaly detection model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public AnomalyDetector withDimensions(Dimension... dimensions) {
if (this.dimensions == null) {
setDimensions(new com.amazonaws.internal.SdkInternalList(dimensions.length));
}
for (Dimension ele : dimensions) {
this.dimensions.add(ele);
}
return this;
}
/**
*
* The metric dimensions associated with the anomaly detection model.
*
*
* @param dimensions
* The metric dimensions associated with the anomaly detection model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public AnomalyDetector withDimensions(java.util.Collection dimensions) {
setDimensions(dimensions);
return this;
}
/**
*
* The statistic associated with the anomaly detection model.
*
*
* @param stat
* The statistic associated with the anomaly detection model.
*/
@Deprecated
public void setStat(String stat) {
this.stat = stat;
}
/**
*
* The statistic associated with the anomaly detection model.
*
*
* @return The statistic associated with the anomaly detection model.
*/
@Deprecated
public String getStat() {
return this.stat;
}
/**
*
* The statistic associated with the anomaly detection model.
*
*
* @param stat
* The statistic associated with the anomaly detection model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public AnomalyDetector withStat(String stat) {
setStat(stat);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setConfiguration(AnomalyDetectorConfiguration configuration) {
this.configuration = 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.
*
*
* @return 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.
*/
public AnomalyDetectorConfiguration getConfiguration() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnomalyDetector withConfiguration(AnomalyDetectorConfiguration configuration) {
setConfiguration(configuration);
return this;
}
/**
*
* The current status of the anomaly detector's training.
*
*
* @param stateValue
* The current status of the anomaly detector's training.
* @see AnomalyDetectorStateValue
*/
public void setStateValue(String stateValue) {
this.stateValue = stateValue;
}
/**
*
* The current status of the anomaly detector's training.
*
*
* @return The current status of the anomaly detector's training.
* @see AnomalyDetectorStateValue
*/
public String getStateValue() {
return this.stateValue;
}
/**
*
* The current status of the anomaly detector's training.
*
*
* @param stateValue
* The current status of the anomaly detector's training.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AnomalyDetectorStateValue
*/
public AnomalyDetector withStateValue(String stateValue) {
setStateValue(stateValue);
return this;
}
/**
*
* The current status of the anomaly detector's training.
*
*
* @param stateValue
* The current status of the anomaly detector's training.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AnomalyDetectorStateValue
*/
public AnomalyDetector withStateValue(AnomalyDetectorStateValue stateValue) {
this.stateValue = stateValue.toString();
return this;
}
/**
*
* This object includes parameters that you can use to provide information about your metric to CloudWatch to help
* it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes
* parameter.
*
*
* @param metricCharacteristics
* This object includes parameters that you can use to provide information about your metric to CloudWatch to
* help it build more accurate anomaly detection models. Currently, it includes the
* PeriodicSpikes parameter.
*/
public void setMetricCharacteristics(MetricCharacteristics metricCharacteristics) {
this.metricCharacteristics = metricCharacteristics;
}
/**
*
* This object includes parameters that you can use to provide information about your metric to CloudWatch to help
* it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes
* parameter.
*
*
* @return This object includes parameters that you can use to provide information about your metric to CloudWatch
* to help it build more accurate anomaly detection models. Currently, it includes the
* PeriodicSpikes parameter.
*/
public MetricCharacteristics getMetricCharacteristics() {
return this.metricCharacteristics;
}
/**
*
* This object includes parameters that you can use to provide information about your metric to CloudWatch to help
* it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes
* parameter.
*
*
* @param metricCharacteristics
* This object includes parameters that you can use to provide information about your metric to CloudWatch to
* help it build more accurate anomaly detection models. Currently, it includes the
* PeriodicSpikes parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnomalyDetector withMetricCharacteristics(MetricCharacteristics metricCharacteristics) {
setMetricCharacteristics(metricCharacteristics);
return this;
}
/**
*
* The CloudWatch metric and statistic for this anomaly detector.
*
*
* @param singleMetricAnomalyDetector
* The CloudWatch metric and statistic for this anomaly detector.
*/
public void setSingleMetricAnomalyDetector(SingleMetricAnomalyDetector singleMetricAnomalyDetector) {
this.singleMetricAnomalyDetector = singleMetricAnomalyDetector;
}
/**
*
* The CloudWatch metric and statistic for this anomaly detector.
*
*
* @return The CloudWatch metric and statistic for this anomaly detector.
*/
public SingleMetricAnomalyDetector getSingleMetricAnomalyDetector() {
return this.singleMetricAnomalyDetector;
}
/**
*
* The CloudWatch metric and statistic for this anomaly detector.
*
*
* @param singleMetricAnomalyDetector
* The CloudWatch metric and statistic for this anomaly detector.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnomalyDetector withSingleMetricAnomalyDetector(SingleMetricAnomalyDetector singleMetricAnomalyDetector) {
setSingleMetricAnomalyDetector(singleMetricAnomalyDetector);
return this;
}
/**
*
* The CloudWatch metric math expression for this anomaly detector.
*
*
* @param metricMathAnomalyDetector
* The CloudWatch metric math expression for this anomaly detector.
*/
public void setMetricMathAnomalyDetector(MetricMathAnomalyDetector metricMathAnomalyDetector) {
this.metricMathAnomalyDetector = metricMathAnomalyDetector;
}
/**
*
* The CloudWatch metric math expression for this anomaly detector.
*
*
* @return The CloudWatch metric math expression for this anomaly detector.
*/
public MetricMathAnomalyDetector getMetricMathAnomalyDetector() {
return this.metricMathAnomalyDetector;
}
/**
*
* The CloudWatch metric math expression for this anomaly detector.
*
*
* @param metricMathAnomalyDetector
* The CloudWatch metric math expression for this anomaly detector.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AnomalyDetector withMetricMathAnomalyDetector(MetricMathAnomalyDetector metricMathAnomalyDetector) {
setMetricMathAnomalyDetector(metricMathAnomalyDetector);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getNamespace() != null)
sb.append("Namespace: ").append(getNamespace()).append(",");
if (getMetricName() != null)
sb.append("MetricName: ").append(getMetricName()).append(",");
if (getDimensions() != null)
sb.append("Dimensions: ").append(getDimensions()).append(",");
if (getStat() != null)
sb.append("Stat: ").append(getStat()).append(",");
if (getConfiguration() != null)
sb.append("Configuration: ").append(getConfiguration()).append(",");
if (getStateValue() != null)
sb.append("StateValue: ").append(getStateValue()).append(",");
if (getMetricCharacteristics() != null)
sb.append("MetricCharacteristics: ").append(getMetricCharacteristics()).append(",");
if (getSingleMetricAnomalyDetector() != null)
sb.append("SingleMetricAnomalyDetector: ").append(getSingleMetricAnomalyDetector()).append(",");
if (getMetricMathAnomalyDetector() != null)
sb.append("MetricMathAnomalyDetector: ").append(getMetricMathAnomalyDetector());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AnomalyDetector == false)
return false;
AnomalyDetector other = (AnomalyDetector) obj;
if (other.getNamespace() == null ^ this.getNamespace() == null)
return false;
if (other.getNamespace() != null && other.getNamespace().equals(this.getNamespace()) == false)
return false;
if (other.getMetricName() == null ^ this.getMetricName() == null)
return false;
if (other.getMetricName() != null && other.getMetricName().equals(this.getMetricName()) == false)
return false;
if (other.getDimensions() == null ^ this.getDimensions() == null)
return false;
if (other.getDimensions() != null && other.getDimensions().equals(this.getDimensions()) == false)
return false;
if (other.getStat() == null ^ this.getStat() == null)
return false;
if (other.getStat() != null && other.getStat().equals(this.getStat()) == false)
return false;
if (other.getConfiguration() == null ^ this.getConfiguration() == null)
return false;
if (other.getConfiguration() != null && other.getConfiguration().equals(this.getConfiguration()) == false)
return false;
if (other.getStateValue() == null ^ this.getStateValue() == null)
return false;
if (other.getStateValue() != null && other.getStateValue().equals(this.getStateValue()) == false)
return false;
if (other.getMetricCharacteristics() == null ^ this.getMetricCharacteristics() == null)
return false;
if (other.getMetricCharacteristics() != null && other.getMetricCharacteristics().equals(this.getMetricCharacteristics()) == false)
return false;
if (other.getSingleMetricAnomalyDetector() == null ^ this.getSingleMetricAnomalyDetector() == null)
return false;
if (other.getSingleMetricAnomalyDetector() != null && other.getSingleMetricAnomalyDetector().equals(this.getSingleMetricAnomalyDetector()) == false)
return false;
if (other.getMetricMathAnomalyDetector() == null ^ this.getMetricMathAnomalyDetector() == null)
return false;
if (other.getMetricMathAnomalyDetector() != null && other.getMetricMathAnomalyDetector().equals(this.getMetricMathAnomalyDetector()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNamespace() == null) ? 0 : getNamespace().hashCode());
hashCode = prime * hashCode + ((getMetricName() == null) ? 0 : getMetricName().hashCode());
hashCode = prime * hashCode + ((getDimensions() == null) ? 0 : getDimensions().hashCode());
hashCode = prime * hashCode + ((getStat() == null) ? 0 : getStat().hashCode());
hashCode = prime * hashCode + ((getConfiguration() == null) ? 0 : getConfiguration().hashCode());
hashCode = prime * hashCode + ((getStateValue() == null) ? 0 : getStateValue().hashCode());
hashCode = prime * hashCode + ((getMetricCharacteristics() == null) ? 0 : getMetricCharacteristics().hashCode());
hashCode = prime * hashCode + ((getSingleMetricAnomalyDetector() == null) ? 0 : getSingleMetricAnomalyDetector().hashCode());
hashCode = prime * hashCode + ((getMetricMathAnomalyDetector() == null) ? 0 : getMetricMathAnomalyDetector().hashCode());
return hashCode;
}
@Override
public AnomalyDetector clone() {
try {
return (AnomalyDetector) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}