com.amazonaws.services.autoscaling.model.ExecutePolicyRequest Maven / Gradle / Ivy
Show all versions of aws-android-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;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.autoscaling.AmazonAutoScaling#executePolicy(ExecutePolicyRequest) ExecutePolicy operation}.
*
* Executes the specified policy.
*
*
* @see com.amazonaws.services.autoscaling.AmazonAutoScaling#executePolicy(ExecutePolicyRequest)
*/
public class ExecutePolicyRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name or Amazon Resource Name (ARN) of the Auto Scaling group.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String autoScalingGroupName;
/**
* The name or ARN of the policy.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String policyName;
/**
* 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.
This parameter is not supported if the policy type is
* StepScaling.
For more information, see Understanding
* Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
*/
private Boolean honorCooldown;
/**
* The metric value to compare to BreachThreshold. This
* enables you to execute a policy of type StepScaling 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.
If you specify a metric value that doesn't correspond to a step
* adjustment for the policy, the call returns an error.
This
* parameter is required if the policy type is StepScaling
* and not supported otherwise.
*/
private Double metricValue;
/**
* The breach threshold for the alarm.
This parameter is required if
* the policy type is StepScaling and not supported
* otherwise.
*/
private Double breachThreshold;
/**
* The name or Amazon Resource Name (ARN) of the Auto Scaling group.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return The name or Amazon Resource Name (ARN) of the Auto Scaling group.
*/
public String getAutoScalingGroupName() {
return autoScalingGroupName;
}
/**
* The name or Amazon Resource Name (ARN) of the Auto Scaling group.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param autoScalingGroupName The name or Amazon Resource Name (ARN) of the Auto Scaling group.
*/
public void setAutoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
}
/**
* The name or Amazon Resource Name (ARN) of the Auto Scaling group.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param autoScalingGroupName The name or Amazon Resource Name (ARN) of the Auto Scaling group.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ExecutePolicyRequest withAutoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
return this;
}
/**
* The name or ARN of the policy.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return The name or ARN of the policy.
*/
public String getPolicyName() {
return policyName;
}
/**
* The name or ARN of the policy.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param policyName The name or ARN of the policy.
*/
public void setPolicyName(String policyName) {
this.policyName = policyName;
}
/**
* The name or ARN of the policy.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 1600
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param policyName The name or ARN of the policy.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ExecutePolicyRequest withPolicyName(String policyName) {
this.policyName = policyName;
return this;
}
/**
* 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.
This parameter is not supported if the policy type is
* StepScaling.
For more information, see Understanding
* Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
*
* @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.
This parameter is not supported if the policy type is
* StepScaling.
For more information, see Understanding
* Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
*/
public Boolean isHonorCooldown() {
return 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.
This parameter is not supported if the policy type is
* StepScaling.
For more information, see Understanding
* Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
*
* @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.
This parameter is not supported if the policy type is
* StepScaling.
For more information, see Understanding
* Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
*/
public void setHonorCooldown(Boolean honorCooldown) {
this.honorCooldown = 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.
This parameter is not supported if the policy type is
* StepScaling.
For more information, see Understanding
* Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @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.
This parameter is not supported if the policy type is
* StepScaling.
For more information, see Understanding
* Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ExecutePolicyRequest withHonorCooldown(Boolean honorCooldown) {
this.honorCooldown = honorCooldown;
return this;
}
/**
* 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.
This parameter is not supported if the policy type is
* StepScaling.
For more information, see Understanding
* Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
*
* @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.
This parameter is not supported if the policy type is
* StepScaling.
For more information, see Understanding
* Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
*/
public Boolean getHonorCooldown() {
return honorCooldown;
}
/**
* The metric value to compare to BreachThreshold. This
* enables you to execute a policy of type StepScaling 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.
If you specify a metric value that doesn't correspond to a step
* adjustment for the policy, the call returns an error.
This
* parameter is required if the policy type is StepScaling
* and not supported otherwise.
*
* @return The metric value to compare to BreachThreshold. This
* enables you to execute a policy of type StepScaling 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.
If you specify a metric value that doesn't correspond to a step
* adjustment for the policy, the call returns an error.
This
* parameter is required if the policy type is StepScaling
* and not supported otherwise.
*/
public Double getMetricValue() {
return metricValue;
}
/**
* The metric value to compare to BreachThreshold. This
* enables you to execute a policy of type StepScaling 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.
If you specify a metric value that doesn't correspond to a step
* adjustment for the policy, the call returns an error.
This
* parameter is required if the policy type is StepScaling
* and not supported otherwise.
*
* @param metricValue The metric value to compare to BreachThreshold. This
* enables you to execute a policy of type StepScaling 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.
If you specify a metric value that doesn't correspond to a step
* adjustment for the policy, the call returns an error.
This
* parameter is required if the policy type is StepScaling
* and not supported otherwise.
*/
public void setMetricValue(Double metricValue) {
this.metricValue = metricValue;
}
/**
* The metric value to compare to BreachThreshold. This
* enables you to execute a policy of type StepScaling 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.
If you specify a metric value that doesn't correspond to a step
* adjustment for the policy, the call returns an error.
This
* parameter is required if the policy type is StepScaling
* and not supported otherwise.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param metricValue The metric value to compare to BreachThreshold. This
* enables you to execute a policy of type StepScaling 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.
If you specify a metric value that doesn't correspond to a step
* adjustment for the policy, the call returns an error.
This
* parameter is required if the policy type is StepScaling
* and not supported otherwise.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ExecutePolicyRequest withMetricValue(Double metricValue) {
this.metricValue = metricValue;
return this;
}
/**
* The breach threshold for the alarm.
This parameter is required if
* the policy type is StepScaling and not supported
* otherwise.
*
* @return The breach threshold for the alarm.
This parameter is required if
* the policy type is StepScaling and not supported
* otherwise.
*/
public Double getBreachThreshold() {
return breachThreshold;
}
/**
* The breach threshold for the alarm.
This parameter is required if
* the policy type is StepScaling and not supported
* otherwise.
*
* @param breachThreshold The breach threshold for the alarm.
This parameter is required if
* the policy type is StepScaling and not supported
* otherwise.
*/
public void setBreachThreshold(Double breachThreshold) {
this.breachThreshold = breachThreshold;
}
/**
* The breach threshold for the alarm.
This parameter is required if
* the policy type is StepScaling and not supported
* otherwise.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param breachThreshold The breach threshold for the alarm.
This parameter is required if
* the policy type is StepScaling and not supported
* otherwise.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ExecutePolicyRequest withBreachThreshold(Double breachThreshold) {
this.breachThreshold = 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: " + getAutoScalingGroupName() + ",");
if (getPolicyName() != null) sb.append("PolicyName: " + getPolicyName() + ",");
if (isHonorCooldown() != null) sb.append("HonorCooldown: " + isHonorCooldown() + ",");
if (getMetricValue() != null) sb.append("MetricValue: " + getMetricValue() + ",");
if (getBreachThreshold() != null) sb.append("BreachThreshold: " + getBreachThreshold() );
sb.append("}");
return sb.toString();
}
@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 + ((isHonorCooldown() == null) ? 0 : isHonorCooldown().hashCode());
hashCode = prime * hashCode + ((getMetricValue() == null) ? 0 : getMetricValue().hashCode());
hashCode = prime * hashCode + ((getBreachThreshold() == null) ? 0 : getBreachThreshold().hashCode());
return hashCode;
}
@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.isHonorCooldown() == null ^ this.isHonorCooldown() == null) return false;
if (other.isHonorCooldown() != null && other.isHonorCooldown().equals(this.isHonorCooldown()) == 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;
}
}