/*
* Copyright 2012-2017 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;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ExecutePolicy" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ExecutePolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
* <p>
* The name or Amazon Resource Name (ARN) of the Auto Scaling group.
* </p>
*/
private String autoScalingGroupName;
/**
* <p>
* The name or ARN of the policy.
* </p>
*/
private String policyName;
/**
* <p>
* If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.
* Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.
* </p>
* <p>
* This parameter is not supported if the policy type is <code>StepScaling</code>.
* </p>
* <p>
* For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html">Auto
* Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.
* </p>
*/
private Boolean honorCooldown;
/**
* <p>
* The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type
* <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold is 50
* and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric
* value to 59.
* </p>
* <p>
* If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an
* error.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
* </p>
*/
private Double metricValue;
/**
* <p>
* The breach threshold for the alarm.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
* </p>
*/
private Double breachThreshold;
/**
* <p>
* The name or Amazon Resource Name (ARN) of the Auto Scaling group.
* </p>
*
* @param autoScalingGroupName
* The name or Amazon Resource Name (ARN) of the Auto Scaling group.
*/
public void setAutoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
}
/**
* <p>
* The name or Amazon Resource Name (ARN) of the Auto Scaling group.
* </p>
*
* @return The name or Amazon Resource Name (ARN) of the Auto Scaling group.
*/
public String getAutoScalingGroupName() {
return this.autoScalingGroupName;
}
/**
* <p>
* The name or Amazon Resource Name (ARN) of the Auto Scaling group.
* </p>
*
* @param autoScalingGroupName
* The name or Amazon Resource Name (ARN) of the Auto Scaling group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExecutePolicyRequest withAutoScalingGroupName(String autoScalingGroupName) {
setAutoScalingGroupName(autoScalingGroupName);
return this;
}
/**
* <p>
* The name or ARN of the policy.
* </p>
*
* @param policyName
* The name or ARN of the policy.
*/
public void setPolicyName(String policyName) {
this.policyName = policyName;
}
/**
* <p>
* The name or ARN of the policy.
* </p>
*
* @return The name or ARN of the policy.
*/
public String getPolicyName() {
return this.policyName;
}
/**
* <p>
* The name or ARN of the policy.
* </p>
*
* @param policyName
* The name or ARN of the policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExecutePolicyRequest withPolicyName(String policyName) {
setPolicyName(policyName);
return this;
}
/**
* <p>
* If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.
* Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.
* </p>
* <p>
* This parameter is not supported if the policy type is <code>StepScaling</code>.
* </p>
* <p>
* For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html">Auto
* Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.
* </p>
*
* @param honorCooldown
* If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the
* policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to
* complete.</p>
* <p>
* This parameter is not supported if the policy type is <code>StepScaling</code>.
* </p>
* <p>
* For more information, see <a
* href="http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html">Auto Scaling Cooldowns</a> in
* the <i>Auto Scaling User Guide</i>.
*/
public void setHonorCooldown(Boolean honorCooldown) {
this.honorCooldown = honorCooldown;
}
/**
* <p>
* If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.
* Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.
* </p>
* <p>
* This parameter is not supported if the policy type is <code>StepScaling</code>.
* </p>
* <p>
* For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html">Auto
* Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.
* </p>
*
* @return If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the
* policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to
* complete.</p>
* <p>
* This parameter is not supported if the policy type is <code>StepScaling</code>.
* </p>
* <p>
* For more information, see <a
* href="http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html">Auto Scaling Cooldowns</a>
* in the <i>Auto Scaling User Guide</i>.
*/
public Boolean getHonorCooldown() {
return this.honorCooldown;
}
/**
* <p>
* If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.
* Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.
* </p>
* <p>
* This parameter is not supported if the policy type is <code>StepScaling</code>.
* </p>
* <p>
* For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html">Auto
* Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.
* </p>
*
* @param honorCooldown
* If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the
* policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to
* complete.</p>
* <p>
* This parameter is not supported if the policy type is <code>StepScaling</code>.
* </p>
* <p>
* For more information, see <a
* href="http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html">Auto Scaling Cooldowns</a> in
* the <i>Auto Scaling User Guide</i>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExecutePolicyRequest withHonorCooldown(Boolean honorCooldown) {
setHonorCooldown(honorCooldown);
return this;
}
/**
* <p>
* If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.
* Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.
* </p>
* <p>
* This parameter is not supported if the policy type is <code>StepScaling</code>.
* </p>
* <p>
* For more information, see <a href="http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html">Auto
* Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.
* </p>
*
* @return If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the
* policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to
* complete.</p>
* <p>
* This parameter is not supported if the policy type is <code>StepScaling</code>.
* </p>
* <p>
* For more information, see <a
* href="http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html">Auto Scaling Cooldowns</a>
* in the <i>Auto Scaling User Guide</i>.
*/
public Boolean isHonorCooldown() {
return this.honorCooldown;
}
/**
* <p>
* The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type
* <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold is 50
* and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric
* value to 59.
* </p>
* <p>
* If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an
* error.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
* </p>
*
* @param metricValue
* The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type
* <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold
* is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set
* the metric value to 59.</p>
* <p>
* If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call
* returns an error.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
*/
public void setMetricValue(Double metricValue) {
this.metricValue = metricValue;
}
/**
* <p>
* The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type
* <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold is 50
* and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric
* value to 59.
* </p>
* <p>
* If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an
* error.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
* </p>
*
* @return The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type
* <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold
* is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set
* the metric value to 59.</p>
* <p>
* If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call
* returns an error.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
*/
public Double getMetricValue() {
return this.metricValue;
}
/**
* <p>
* The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type
* <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold is 50
* and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric
* value to 59.
* </p>
* <p>
* If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an
* error.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
* </p>
*
* @param metricValue
* The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type
* <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold
* is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set
* the metric value to 59.</p>
* <p>
* If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call
* returns an error.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExecutePolicyRequest withMetricValue(Double metricValue) {
setMetricValue(metricValue);
return this;
}
/**
* <p>
* The breach threshold for the alarm.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
* </p>
*
* @param breachThreshold
* The breach threshold for the alarm.</p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
*/
public void setBreachThreshold(Double breachThreshold) {
this.breachThreshold = breachThreshold;
}
/**
* <p>
* The breach threshold for the alarm.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
* </p>
*
* @return The breach threshold for the alarm.</p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
*/
public Double getBreachThreshold() {
return this.breachThreshold;
}
/**
* <p>
* The breach threshold for the alarm.
* </p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
* </p>
*
* @param breachThreshold
* The breach threshold for the alarm.</p>
* <p>
* This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExecutePolicyRequest withBreachThreshold(Double breachThreshold) {
setBreachThreshold(breachThreshold);
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 (getAutoScalingGroupName() != null)
sb.append("AutoScalingGroupName: ").append(getAutoScalingGroupName()).append(",");
if (getPolicyName() != null)
sb.append("PolicyName: ").append(getPolicyName()).append(",");
if (getHonorCooldown() != null)
sb.append("HonorCooldown: ").append(getHonorCooldown()).append(",");
if (getMetricValue() != null)
sb.append("MetricValue: ").append(getMetricValue()).append(",");
if (getBreachThreshold() != null)
sb.append("BreachThreshold: ").append(getBreachThreshold());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ExecutePolicyRequest == false)
return false;
ExecutePolicyRequest other = (ExecutePolicyRequest) obj;
if (other.getAutoScalingGroupName() == null ^ this.getAutoScalingGroupName() == null)
return false;
if (other.getAutoScalingGroupName() != null && other.getAutoScalingGroupName().equals(this.getAutoScalingGroupName()) == false)
return false;
if (other.getPolicyName() == null ^ this.getPolicyName() == null)
return false;
if (other.getPolicyName() != null && other.getPolicyName().equals(this.getPolicyName()) == false)
return false;
if (other.getHonorCooldown() == null ^ this.getHonorCooldown() == null)
return false;
if (other.getHonorCooldown() != null && other.getHonorCooldown().equals(this.getHonorCooldown()) == false)
return false;
if (other.getMetricValue() == null ^ this.getMetricValue() == null)
return false;
if (other.getMetricValue() != null && other.getMetricValue().equals(this.getMetricValue()) == false)
return false;
if (other.getBreachThreshold() == null ^ this.getBreachThreshold() == null)
return false;
if (other.getBreachThreshold() != null && other.getBreachThreshold().equals(this.getBreachThreshold()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAutoScalingGroupName() == null) ? 0 : getAutoScalingGroupName().hashCode());
hashCode = prime * hashCode + ((getPolicyName() == null) ? 0 : getPolicyName().hashCode());
hashCode = prime * hashCode + ((getHonorCooldown() == null) ? 0 : getHonorCooldown().hashCode());
hashCode = prime * hashCode + ((getMetricValue() == null) ? 0 : getMetricValue().hashCode());
hashCode = prime * hashCode + ((getBreachThreshold() == null) ? 0 : getBreachThreshold().hashCode());
return hashCode;
}
@Override
public ExecutePolicyRequest clone() {
return (ExecutePolicyRequest) super.clone();
}
}