software.amazon.awssdk.services.dynamodb.model.AutoScalingTargetTrackingScalingPolicyConfigurationDescription Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.dynamodb.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents the properties of a target tracking scaling policy.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AutoScalingTargetTrackingScalingPolicyConfigurationDescription
implements
SdkPojo,
Serializable,
ToCopyableBuilder {
private static final SdkField DISABLE_SCALE_IN_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DisableScaleIn")
.getter(getter(AutoScalingTargetTrackingScalingPolicyConfigurationDescription::disableScaleIn))
.setter(setter(Builder::disableScaleIn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DisableScaleIn").build()).build();
private static final SdkField SCALE_IN_COOLDOWN_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("ScaleInCooldown")
.getter(getter(AutoScalingTargetTrackingScalingPolicyConfigurationDescription::scaleInCooldown))
.setter(setter(Builder::scaleInCooldown))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScaleInCooldown").build()).build();
private static final SdkField SCALE_OUT_COOLDOWN_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("ScaleOutCooldown")
.getter(getter(AutoScalingTargetTrackingScalingPolicyConfigurationDescription::scaleOutCooldown))
.setter(setter(Builder::scaleOutCooldown))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScaleOutCooldown").build()).build();
private static final SdkField TARGET_VALUE_FIELD = SdkField. builder(MarshallingType.DOUBLE)
.memberName("TargetValue")
.getter(getter(AutoScalingTargetTrackingScalingPolicyConfigurationDescription::targetValue))
.setter(setter(Builder::targetValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetValue").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DISABLE_SCALE_IN_FIELD,
SCALE_IN_COOLDOWN_FIELD, SCALE_OUT_COOLDOWN_FIELD, TARGET_VALUE_FIELD));
private static final long serialVersionUID = 1L;
private final Boolean disableScaleIn;
private final Integer scaleInCooldown;
private final Integer scaleOutCooldown;
private final Double targetValue;
private AutoScalingTargetTrackingScalingPolicyConfigurationDescription(BuilderImpl builder) {
this.disableScaleIn = builder.disableScaleIn;
this.scaleInCooldown = builder.scaleInCooldown;
this.scaleOutCooldown = builder.scaleOutCooldown;
this.targetValue = builder.targetValue;
}
/**
*
* Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled
* and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled
* and the target tracking policy can remove capacity from the scalable resource. The default value is false.
*
*
* @return Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is
* disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise,
* scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The
* default value is false.
*/
public final Boolean disableScaleIn() {
return disableScaleIn;
}
/**
*
* The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
* The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in
* conservatively to protect your application's availability. However, if another alarm triggers a scale out policy
* during the cooldown period after a scale-in, application auto scaling scales out your scalable target
* immediately.
*
*
* @return The amount of time, in seconds, after a scale in activity completes before another scale in activity can
* start. The cooldown period is used to block subsequent scale in requests until it has expired. You should
* scale in conservatively to protect your application's availability. However, if another alarm triggers a
* scale out policy during the cooldown period after a scale-in, application auto scaling scales out your
* scalable target immediately.
*/
public final Integer scaleInCooldown() {
return scaleInCooldown;
}
/**
*
* The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.
* While the cooldown period is in effect, the capacity that has been added by the previous scale out event that
* initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should
* continuously (but not excessively) scale out.
*
*
* @return The amount of time, in seconds, after a scale out activity completes before another scale out activity
* can start. While the cooldown period is in effect, the capacity that has been added by the previous scale
* out event that initiated the cooldown is calculated as part of the desired capacity for the next scale
* out. You should continuously (but not excessively) scale out.
*/
public final Integer scaleOutCooldown() {
return scaleOutCooldown;
}
/**
*
* The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base
* 2).
*
*
* @return The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360
* (Base 2).
*/
public final Double targetValue() {
return targetValue;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(disableScaleIn());
hashCode = 31 * hashCode + Objects.hashCode(scaleInCooldown());
hashCode = 31 * hashCode + Objects.hashCode(scaleOutCooldown());
hashCode = 31 * hashCode + Objects.hashCode(targetValue());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AutoScalingTargetTrackingScalingPolicyConfigurationDescription)) {
return false;
}
AutoScalingTargetTrackingScalingPolicyConfigurationDescription other = (AutoScalingTargetTrackingScalingPolicyConfigurationDescription) obj;
return Objects.equals(disableScaleIn(), other.disableScaleIn())
&& Objects.equals(scaleInCooldown(), other.scaleInCooldown())
&& Objects.equals(scaleOutCooldown(), other.scaleOutCooldown())
&& Objects.equals(targetValue(), other.targetValue());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("AutoScalingTargetTrackingScalingPolicyConfigurationDescription")
.add("DisableScaleIn", disableScaleIn()).add("ScaleInCooldown", scaleInCooldown())
.add("ScaleOutCooldown", scaleOutCooldown()).add("TargetValue", targetValue()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DisableScaleIn":
return Optional.ofNullable(clazz.cast(disableScaleIn()));
case "ScaleInCooldown":
return Optional.ofNullable(clazz.cast(scaleInCooldown()));
case "ScaleOutCooldown":
return Optional.ofNullable(clazz.cast(scaleOutCooldown()));
case "TargetValue":
return Optional.ofNullable(clazz.cast(targetValue()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AutoScalingTargetTrackingScalingPolicyConfigurationDescription) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo,
CopyableBuilder {
/**
*
* Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is
* disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in
* is enabled and the target tracking policy can remove capacity from the scalable resource. The default value
* is false.
*
*
* @param disableScaleIn
* Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in
* is disabled and the target tracking policy won't remove capacity from the scalable resource.
* Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable
* resource. The default value is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder disableScaleIn(Boolean disableScaleIn);
/**
*
* The amount of time, in seconds, after a scale in activity completes before another scale in activity can
* start. The cooldown period is used to block subsequent scale in requests until it has expired. You should
* scale in conservatively to protect your application's availability. However, if another alarm triggers a
* scale out policy during the cooldown period after a scale-in, application auto scaling scales out your
* scalable target immediately.
*
*
* @param scaleInCooldown
* The amount of time, in seconds, after a scale in activity completes before another scale in activity
* can start. The cooldown period is used to block subsequent scale in requests until it has expired. You
* should scale in conservatively to protect your application's availability. However, if another alarm
* triggers a scale out policy during the cooldown period after a scale-in, application auto scaling
* scales out your scalable target immediately.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scaleInCooldown(Integer scaleInCooldown);
/**
*
* The amount of time, in seconds, after a scale out activity completes before another scale out activity can
* start. While the cooldown period is in effect, the capacity that has been added by the previous scale out
* event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You
* should continuously (but not excessively) scale out.
*
*
* @param scaleOutCooldown
* The amount of time, in seconds, after a scale out activity completes before another scale out activity
* can start. While the cooldown period is in effect, the capacity that has been added by the previous
* scale out event that initiated the cooldown is calculated as part of the desired capacity for the next
* scale out. You should continuously (but not excessively) scale out.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scaleOutCooldown(Integer scaleOutCooldown);
/**
*
* The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360
* (Base 2).
*
*
* @param targetValue
* The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to
* 2e360 (Base 2).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetValue(Double targetValue);
}
static final class BuilderImpl implements Builder {
private Boolean disableScaleIn;
private Integer scaleInCooldown;
private Integer scaleOutCooldown;
private Double targetValue;
private BuilderImpl() {
}
private BuilderImpl(AutoScalingTargetTrackingScalingPolicyConfigurationDescription model) {
disableScaleIn(model.disableScaleIn);
scaleInCooldown(model.scaleInCooldown);
scaleOutCooldown(model.scaleOutCooldown);
targetValue(model.targetValue);
}
public final Boolean getDisableScaleIn() {
return disableScaleIn;
}
@Override
public final Builder disableScaleIn(Boolean disableScaleIn) {
this.disableScaleIn = disableScaleIn;
return this;
}
public final void setDisableScaleIn(Boolean disableScaleIn) {
this.disableScaleIn = disableScaleIn;
}
public final Integer getScaleInCooldown() {
return scaleInCooldown;
}
@Override
public final Builder scaleInCooldown(Integer scaleInCooldown) {
this.scaleInCooldown = scaleInCooldown;
return this;
}
public final void setScaleInCooldown(Integer scaleInCooldown) {
this.scaleInCooldown = scaleInCooldown;
}
public final Integer getScaleOutCooldown() {
return scaleOutCooldown;
}
@Override
public final Builder scaleOutCooldown(Integer scaleOutCooldown) {
this.scaleOutCooldown = scaleOutCooldown;
return this;
}
public final void setScaleOutCooldown(Integer scaleOutCooldown) {
this.scaleOutCooldown = scaleOutCooldown;
}
public final Double getTargetValue() {
return targetValue;
}
@Override
public final Builder targetValue(Double targetValue) {
this.targetValue = targetValue;
return this;
}
public final void setTargetValue(Double targetValue) {
this.targetValue = targetValue;
}
@Override
public AutoScalingTargetTrackingScalingPolicyConfigurationDescription build() {
return new AutoScalingTargetTrackingScalingPolicyConfigurationDescription(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}