com.amazonaws.services.elasticmapreduce.model.SimpleScalingPolicyConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-emr Show documentation
/*
* Copyright 2017-2022 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.elasticmapreduce.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period,
* and the number of EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SimpleScalingPolicyConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated
* (if ScalingAdjustment is a negative number) each time the scaling activity is triggered.
* CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance
* count increments or decrements by ScalingAdjustment, which should be expressed as an integer.
* PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage
* specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates
* an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity
* results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which
* should be expressed as a positive integer.
*
*/
private String adjustmentType;
/**
*
* The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive
* value adds to the instance group's EC2 instance count while a negative number removes instances. If
* AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer.
* If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the
* percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
*
*/
private Integer scalingAdjustment;
/**
*
* The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling
* activities can start. The default value is 0.
*
*/
private Integer coolDown;
/**
*
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated
* (if ScalingAdjustment is a negative number) each time the scaling activity is triggered.
* CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance
* count increments or decrements by ScalingAdjustment, which should be expressed as an integer.
* PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage
* specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates
* an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity
* results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which
* should be expressed as a positive integer.
*
*
* @param adjustmentType
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or
* terminated (if ScalingAdjustment is a negative number) each time the scaling activity is
* triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that
* the EC2 instance count increments or decrements by ScalingAdjustment, which should be
* expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments
* or decrements by the percentage specified by ScalingAdjustment, which should be expressed as
* an integer. For example, 20 indicates an increase in 20% increments of cluster capacity.
* EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of
* EC2 instances specified by ScalingAdjustment, which should be expressed as a positive
* integer.
* @see AdjustmentType
*/
public void setAdjustmentType(String adjustmentType) {
this.adjustmentType = adjustmentType;
}
/**
*
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated
* (if ScalingAdjustment is a negative number) each time the scaling activity is triggered.
* CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance
* count increments or decrements by ScalingAdjustment, which should be expressed as an integer.
* PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage
* specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates
* an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity
* results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which
* should be expressed as a positive integer.
*
*
* @return The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or
* terminated (if ScalingAdjustment is a negative number) each time the scaling activity is
* triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that
* the EC2 instance count increments or decrements by ScalingAdjustment, which should be
* expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments
* or decrements by the percentage specified by ScalingAdjustment, which should be expressed as
* an integer. For example, 20 indicates an increase in 20% increments of cluster capacity.
* EXACT_CAPACITY indicates the scaling activity results in an instance group with the number
* of EC2 instances specified by ScalingAdjustment, which should be expressed as a positive
* integer.
* @see AdjustmentType
*/
public String getAdjustmentType() {
return this.adjustmentType;
}
/**
*
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated
* (if ScalingAdjustment is a negative number) each time the scaling activity is triggered.
* CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance
* count increments or decrements by ScalingAdjustment, which should be expressed as an integer.
* PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage
* specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates
* an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity
* results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which
* should be expressed as a positive integer.
*
*
* @param adjustmentType
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or
* terminated (if ScalingAdjustment is a negative number) each time the scaling activity is
* triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that
* the EC2 instance count increments or decrements by ScalingAdjustment, which should be
* expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments
* or decrements by the percentage specified by ScalingAdjustment, which should be expressed as
* an integer. For example, 20 indicates an increase in 20% increments of cluster capacity.
* EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of
* EC2 instances specified by ScalingAdjustment, which should be expressed as a positive
* integer.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AdjustmentType
*/
public SimpleScalingPolicyConfiguration withAdjustmentType(String adjustmentType) {
setAdjustmentType(adjustmentType);
return this;
}
/**
*
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated
* (if ScalingAdjustment is a negative number) each time the scaling activity is triggered.
* CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance
* count increments or decrements by ScalingAdjustment, which should be expressed as an integer.
* PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage
* specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates
* an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity
* results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which
* should be expressed as a positive integer.
*
*
* @param adjustmentType
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or
* terminated (if ScalingAdjustment is a negative number) each time the scaling activity is
* triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that
* the EC2 instance count increments or decrements by ScalingAdjustment, which should be
* expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments
* or decrements by the percentage specified by ScalingAdjustment, which should be expressed as
* an integer. For example, 20 indicates an increase in 20% increments of cluster capacity.
* EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of
* EC2 instances specified by ScalingAdjustment, which should be expressed as a positive
* integer.
* @see AdjustmentType
*/
public void setAdjustmentType(AdjustmentType adjustmentType) {
withAdjustmentType(adjustmentType);
}
/**
*
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated
* (if ScalingAdjustment is a negative number) each time the scaling activity is triggered.
* CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance
* count increments or decrements by ScalingAdjustment, which should be expressed as an integer.
* PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage
* specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates
* an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity
* results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which
* should be expressed as a positive integer.
*
*
* @param adjustmentType
* The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or
* terminated (if ScalingAdjustment is a negative number) each time the scaling activity is
* triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that
* the EC2 instance count increments or decrements by ScalingAdjustment, which should be
* expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments
* or decrements by the percentage specified by ScalingAdjustment, which should be expressed as
* an integer. For example, 20 indicates an increase in 20% increments of cluster capacity.
* EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of
* EC2 instances specified by ScalingAdjustment, which should be expressed as a positive
* integer.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AdjustmentType
*/
public SimpleScalingPolicyConfiguration withAdjustmentType(AdjustmentType adjustmentType) {
this.adjustmentType = adjustmentType.toString();
return this;
}
/**
*
* The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive
* value adds to the instance group's EC2 instance count while a negative number removes instances. If
* AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer.
* If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the
* percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
*
*
* @param scalingAdjustment
* The amount by which to scale in or scale out, based on the specified AdjustmentType. A
* positive value adds to the instance group's EC2 instance count while a negative number removes instances.
* If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive
* integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value
* should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of
* cluster capacity.
*/
public void setScalingAdjustment(Integer scalingAdjustment) {
this.scalingAdjustment = scalingAdjustment;
}
/**
*
* The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive
* value adds to the instance group's EC2 instance count while a negative number removes instances. If
* AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer.
* If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the
* percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
*
*
* @return The amount by which to scale in or scale out, based on the specified AdjustmentType. A
* positive value adds to the instance group's EC2 instance count while a negative number removes instances.
* If AdjustmentType is set to EXACT_CAPACITY, the number should only be a
* positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the
* value should express the percentage as an integer. For example, -20 indicates a decrease in 20%
* increments of cluster capacity.
*/
public Integer getScalingAdjustment() {
return this.scalingAdjustment;
}
/**
*
* The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive
* value adds to the instance group's EC2 instance count while a negative number removes instances. If
* AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer.
* If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the
* percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
*
*
* @param scalingAdjustment
* The amount by which to scale in or scale out, based on the specified AdjustmentType. A
* positive value adds to the instance group's EC2 instance count while a negative number removes instances.
* If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive
* integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value
* should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of
* cluster capacity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SimpleScalingPolicyConfiguration withScalingAdjustment(Integer scalingAdjustment) {
setScalingAdjustment(scalingAdjustment);
return this;
}
/**
*
* The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling
* activities can start. The default value is 0.
*
*
* @param coolDown
* The amount of time, in seconds, after a scaling activity completes before any further trigger-related
* scaling activities can start. The default value is 0.
*/
public void setCoolDown(Integer coolDown) {
this.coolDown = coolDown;
}
/**
*
* The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling
* activities can start. The default value is 0.
*
*
* @return The amount of time, in seconds, after a scaling activity completes before any further trigger-related
* scaling activities can start. The default value is 0.
*/
public Integer getCoolDown() {
return this.coolDown;
}
/**
*
* The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling
* activities can start. The default value is 0.
*
*
* @param coolDown
* The amount of time, in seconds, after a scaling activity completes before any further trigger-related
* scaling activities can start. The default value is 0.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SimpleScalingPolicyConfiguration withCoolDown(Integer coolDown) {
setCoolDown(coolDown);
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 (getAdjustmentType() != null)
sb.append("AdjustmentType: ").append(getAdjustmentType()).append(",");
if (getScalingAdjustment() != null)
sb.append("ScalingAdjustment: ").append(getScalingAdjustment()).append(",");
if (getCoolDown() != null)
sb.append("CoolDown: ").append(getCoolDown());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SimpleScalingPolicyConfiguration == false)
return false;
SimpleScalingPolicyConfiguration other = (SimpleScalingPolicyConfiguration) obj;
if (other.getAdjustmentType() == null ^ this.getAdjustmentType() == null)
return false;
if (other.getAdjustmentType() != null && other.getAdjustmentType().equals(this.getAdjustmentType()) == false)
return false;
if (other.getScalingAdjustment() == null ^ this.getScalingAdjustment() == null)
return false;
if (other.getScalingAdjustment() != null && other.getScalingAdjustment().equals(this.getScalingAdjustment()) == false)
return false;
if (other.getCoolDown() == null ^ this.getCoolDown() == null)
return false;
if (other.getCoolDown() != null && other.getCoolDown().equals(this.getCoolDown()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAdjustmentType() == null) ? 0 : getAdjustmentType().hashCode());
hashCode = prime * hashCode + ((getScalingAdjustment() == null) ? 0 : getScalingAdjustment().hashCode());
hashCode = prime * hashCode + ((getCoolDown() == null) ? 0 : getCoolDown().hashCode());
return hashCode;
}
@Override
public SimpleScalingPolicyConfiguration clone() {
try {
return (SimpleScalingPolicyConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.elasticmapreduce.model.transform.SimpleScalingPolicyConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}