com.amazonaws.services.autoscaling.model.StepAdjustment Maven / Gradle / Ivy
Show all versions of aws-java-sdk-autoscaling Show documentation
/*
* Copyright 2010-2016 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.autoscaling.model;
import java.io.Serializable;
/**
*
* Describes an adjustment based on the difference between the value of the
* aggregated CloudWatch metric and the breach threshold that you've defined for
* the alarm.
*
*
* For the following examples, suppose that you have an alarm with a breach
* threshold of 50:
*
*
* -
*
* If you want the adjustment to be triggered when the metric is greater than or
* equal to 50 and less than 60, specify a lower bound of 0 and an upper bound
* of 10.
*
*
* -
*
* If you want the adjustment to be triggered when the metric is greater than 40
* and less than or equal to 50, specify a lower bound of -10 and an upper bound
* of 0.
*
*
*
*
* There are a few rules for the step adjustments for your step policy:
*
*
* -
*
* The ranges of your step adjustments can't overlap or have a gap.
*
*
* -
*
* At most one step adjustment can have a null lower bound. If one step
* adjustment has a negative lower bound, then there must be a step adjustment
* with a null lower bound.
*
*
* -
*
* At most one step adjustment can have a null upper bound. If one step
* adjustment has a positive upper bound, then there must be a step adjustment
* with a null upper bound.
*
*
* -
*
* The upper and lower bound can't be null in the same step adjustment.
*
*
*
*/
public class StepAdjustment implements Serializable, Cloneable {
/**
*
* The lower bound for the difference between the alarm threshold and the
* CloudWatch metric. If the metric value is above the breach threshold, the
* lower bound is inclusive (the metric must be greater than or equal to the
* threshold plus the lower bound). Otherwise, it is exclusive (the metric
* must be greater than the threshold plus the lower bound). A null value
* indicates negative infinity.
*
*/
private Double metricIntervalLowerBound;
/**
*
* The upper bound for the difference between the alarm threshold and the
* CloudWatch metric. If the metric value is above the breach threshold, the
* upper bound is exclusive (the metric must be less than the threshold plus
* the upper bound). Otherwise, it is inclusive (the metric must be less
* than or equal to the threshold plus the upper bound). A null value
* indicates positive infinity.
*
*
* The upper bound must be greater than the lower bound.
*
*/
private Double metricIntervalUpperBound;
/**
*
* The amount by which to scale, based on the specified adjustment type. A
* positive value adds to the current capacity while a negative number
* removes from the current capacity.
*
*/
private Integer scalingAdjustment;
/**
*
* The lower bound for the difference between the alarm threshold and the
* CloudWatch metric. If the metric value is above the breach threshold, the
* lower bound is inclusive (the metric must be greater than or equal to the
* threshold plus the lower bound). Otherwise, it is exclusive (the metric
* must be greater than the threshold plus the lower bound). A null value
* indicates negative infinity.
*
*
* @param metricIntervalLowerBound
* The lower bound for the difference between the alarm threshold and
* the CloudWatch metric. If the metric value is above the breach
* threshold, the lower bound is inclusive (the metric must be
* greater than or equal to the threshold plus the lower bound).
* Otherwise, it is exclusive (the metric must be greater than the
* threshold plus the lower bound). A null value indicates negative
* infinity.
*/
public void setMetricIntervalLowerBound(Double metricIntervalLowerBound) {
this.metricIntervalLowerBound = metricIntervalLowerBound;
}
/**
*
* The lower bound for the difference between the alarm threshold and the
* CloudWatch metric. If the metric value is above the breach threshold, the
* lower bound is inclusive (the metric must be greater than or equal to the
* threshold plus the lower bound). Otherwise, it is exclusive (the metric
* must be greater than the threshold plus the lower bound). A null value
* indicates negative infinity.
*
*
* @return The lower bound for the difference between the alarm threshold
* and the CloudWatch metric. If the metric value is above the
* breach threshold, the lower bound is inclusive (the metric must
* be greater than or equal to the threshold plus the lower bound).
* Otherwise, it is exclusive (the metric must be greater than the
* threshold plus the lower bound). A null value indicates negative
* infinity.
*/
public Double getMetricIntervalLowerBound() {
return this.metricIntervalLowerBound;
}
/**
*
* The lower bound for the difference between the alarm threshold and the
* CloudWatch metric. If the metric value is above the breach threshold, the
* lower bound is inclusive (the metric must be greater than or equal to the
* threshold plus the lower bound). Otherwise, it is exclusive (the metric
* must be greater than the threshold plus the lower bound). A null value
* indicates negative infinity.
*
*
* @param metricIntervalLowerBound
* The lower bound for the difference between the alarm threshold and
* the CloudWatch metric. If the metric value is above the breach
* threshold, the lower bound is inclusive (the metric must be
* greater than or equal to the threshold plus the lower bound).
* Otherwise, it is exclusive (the metric must be greater than the
* threshold plus the lower bound). A null value indicates negative
* infinity.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public StepAdjustment withMetricIntervalLowerBound(
Double metricIntervalLowerBound) {
setMetricIntervalLowerBound(metricIntervalLowerBound);
return this;
}
/**
*
* The upper bound for the difference between the alarm threshold and the
* CloudWatch metric. If the metric value is above the breach threshold, the
* upper bound is exclusive (the metric must be less than the threshold plus
* the upper bound). Otherwise, it is inclusive (the metric must be less
* than or equal to the threshold plus the upper bound). A null value
* indicates positive infinity.
*
*
* The upper bound must be greater than the lower bound.
*
*
* @param metricIntervalUpperBound
* The upper bound for the difference between the alarm threshold and
* the CloudWatch metric. If the metric value is above the breach
* threshold, the upper bound is exclusive (the metric must be less
* than the threshold plus the upper bound). Otherwise, it is
* inclusive (the metric must be less than or equal to the threshold
* plus the upper bound). A null value indicates positive
* infinity.
*
* The upper bound must be greater than the lower bound.
*/
public void setMetricIntervalUpperBound(Double metricIntervalUpperBound) {
this.metricIntervalUpperBound = metricIntervalUpperBound;
}
/**
*
* The upper bound for the difference between the alarm threshold and the
* CloudWatch metric. If the metric value is above the breach threshold, the
* upper bound is exclusive (the metric must be less than the threshold plus
* the upper bound). Otherwise, it is inclusive (the metric must be less
* than or equal to the threshold plus the upper bound). A null value
* indicates positive infinity.
*
*
* The upper bound must be greater than the lower bound.
*
*
* @return The upper bound for the difference between the alarm threshold
* and the CloudWatch metric. If the metric value is above the
* breach threshold, the upper bound is exclusive (the metric must
* be less than the threshold plus the upper bound). Otherwise, it
* is inclusive (the metric must be less than or equal to the
* threshold plus the upper bound). A null value indicates positive
* infinity.
*
* The upper bound must be greater than the lower bound.
*/
public Double getMetricIntervalUpperBound() {
return this.metricIntervalUpperBound;
}
/**
*
* The upper bound for the difference between the alarm threshold and the
* CloudWatch metric. If the metric value is above the breach threshold, the
* upper bound is exclusive (the metric must be less than the threshold plus
* the upper bound). Otherwise, it is inclusive (the metric must be less
* than or equal to the threshold plus the upper bound). A null value
* indicates positive infinity.
*
*
* The upper bound must be greater than the lower bound.
*
*
* @param metricIntervalUpperBound
* The upper bound for the difference between the alarm threshold and
* the CloudWatch metric. If the metric value is above the breach
* threshold, the upper bound is exclusive (the metric must be less
* than the threshold plus the upper bound). Otherwise, it is
* inclusive (the metric must be less than or equal to the threshold
* plus the upper bound). A null value indicates positive
* infinity.
*
* The upper bound must be greater than the lower bound.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public StepAdjustment withMetricIntervalUpperBound(
Double metricIntervalUpperBound) {
setMetricIntervalUpperBound(metricIntervalUpperBound);
return this;
}
/**
*
* The amount by which to scale, based on the specified adjustment type. A
* positive value adds to the current capacity while a negative number
* removes from the current capacity.
*
*
* @param scalingAdjustment
* The amount by which to scale, based on the specified adjustment
* type. A positive value adds to the current capacity while a
* negative number removes from the current capacity.
*/
public void setScalingAdjustment(Integer scalingAdjustment) {
this.scalingAdjustment = scalingAdjustment;
}
/**
*
* The amount by which to scale, based on the specified adjustment type. A
* positive value adds to the current capacity while a negative number
* removes from the current capacity.
*
*
* @return The amount by which to scale, based on the specified adjustment
* type. A positive value adds to the current capacity while a
* negative number removes from the current capacity.
*/
public Integer getScalingAdjustment() {
return this.scalingAdjustment;
}
/**
*
* The amount by which to scale, based on the specified adjustment type. A
* positive value adds to the current capacity while a negative number
* removes from the current capacity.
*
*
* @param scalingAdjustment
* The amount by which to scale, based on the specified adjustment
* type. A positive value adds to the current capacity while a
* negative number removes from the current capacity.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public StepAdjustment withScalingAdjustment(Integer scalingAdjustment) {
setScalingAdjustment(scalingAdjustment);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getMetricIntervalLowerBound() != null)
sb.append("MetricIntervalLowerBound: "
+ getMetricIntervalLowerBound() + ",");
if (getMetricIntervalUpperBound() != null)
sb.append("MetricIntervalUpperBound: "
+ getMetricIntervalUpperBound() + ",");
if (getScalingAdjustment() != null)
sb.append("ScalingAdjustment: " + getScalingAdjustment());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StepAdjustment == false)
return false;
StepAdjustment other = (StepAdjustment) obj;
if (other.getMetricIntervalLowerBound() == null
^ this.getMetricIntervalLowerBound() == null)
return false;
if (other.getMetricIntervalLowerBound() != null
&& other.getMetricIntervalLowerBound().equals(
this.getMetricIntervalLowerBound()) == false)
return false;
if (other.getMetricIntervalUpperBound() == null
^ this.getMetricIntervalUpperBound() == null)
return false;
if (other.getMetricIntervalUpperBound() != null
&& other.getMetricIntervalUpperBound().equals(
this.getMetricIntervalUpperBound()) == false)
return false;
if (other.getScalingAdjustment() == null
^ this.getScalingAdjustment() == null)
return false;
if (other.getScalingAdjustment() != null
&& other.getScalingAdjustment().equals(
this.getScalingAdjustment()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getMetricIntervalLowerBound() == null) ? 0
: getMetricIntervalLowerBound().hashCode());
hashCode = prime
* hashCode
+ ((getMetricIntervalUpperBound() == null) ? 0
: getMetricIntervalUpperBound().hashCode());
hashCode = prime
* hashCode
+ ((getScalingAdjustment() == null) ? 0
: getScalingAdjustment().hashCode());
return hashCode;
}
@Override
public StepAdjustment clone() {
try {
return (StepAdjustment) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}