org.cdk8s.plus31.k8s.HorizontalPodAutoscalerSpec Maven / Gradle / Ivy
package org.cdk8s.plus31.k8s;
/**
* specification of a horizontal pod autoscaler.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-10-12T12:14:17.524Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus31.$Module.class, fqn = "cdk8s-plus-31.k8s.HorizontalPodAutoscalerSpec")
@software.amazon.jsii.Jsii.Proxy(HorizontalPodAutoscalerSpec.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface HorizontalPodAutoscalerSpec extends software.amazon.jsii.JsiiSerializable {
/**
* maxReplicas is the upper limit for the number of pods that can be set by the autoscaler;
*
* cannot be smaller than MinReplicas.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.Number getMaxReplicas();
/**
* reference to scaled resource;
*
* horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull org.cdk8s.plus31.k8s.CrossVersionObjectReference getScaleTargetRef();
/**
* minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.
*
* It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getMinReplicas() {
return null;
}
/**
* targetCPUUtilizationPercentage is the target average CPU utilization (represented as a percentage of requested CPU) over all the pods;
*
* if not specified the default autoscaling policy will be used.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getTargetCpuUtilizationPercentage() {
return null;
}
/**
* @return a {@link Builder} of {@link HorizontalPodAutoscalerSpec}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link HorizontalPodAutoscalerSpec}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.Number maxReplicas;
org.cdk8s.plus31.k8s.CrossVersionObjectReference scaleTargetRef;
java.lang.Number minReplicas;
java.lang.Number targetCpuUtilizationPercentage;
/**
* Sets the value of {@link HorizontalPodAutoscalerSpec#getMaxReplicas}
* @param maxReplicas maxReplicas is the upper limit for the number of pods that can be set by the autoscaler;. This parameter is required.
* cannot be smaller than MinReplicas.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder maxReplicas(java.lang.Number maxReplicas) {
this.maxReplicas = maxReplicas;
return this;
}
/**
* Sets the value of {@link HorizontalPodAutoscalerSpec#getScaleTargetRef}
* @param scaleTargetRef reference to scaled resource;. This parameter is required.
* horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder scaleTargetRef(org.cdk8s.plus31.k8s.CrossVersionObjectReference scaleTargetRef) {
this.scaleTargetRef = scaleTargetRef;
return this;
}
/**
* Sets the value of {@link HorizontalPodAutoscalerSpec#getMinReplicas}
* @param minReplicas minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.
* It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder minReplicas(java.lang.Number minReplicas) {
this.minReplicas = minReplicas;
return this;
}
/**
* Sets the value of {@link HorizontalPodAutoscalerSpec#getTargetCpuUtilizationPercentage}
* @param targetCpuUtilizationPercentage targetCPUUtilizationPercentage is the target average CPU utilization (represented as a percentage of requested CPU) over all the pods;.
* if not specified the default autoscaling policy will be used.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder targetCpuUtilizationPercentage(java.lang.Number targetCpuUtilizationPercentage) {
this.targetCpuUtilizationPercentage = targetCpuUtilizationPercentage;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link HorizontalPodAutoscalerSpec}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public HorizontalPodAutoscalerSpec build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link HorizontalPodAutoscalerSpec}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements HorizontalPodAutoscalerSpec {
private final java.lang.Number maxReplicas;
private final org.cdk8s.plus31.k8s.CrossVersionObjectReference scaleTargetRef;
private final java.lang.Number minReplicas;
private final java.lang.Number targetCpuUtilizationPercentage;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.maxReplicas = software.amazon.jsii.Kernel.get(this, "maxReplicas", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.scaleTargetRef = software.amazon.jsii.Kernel.get(this, "scaleTargetRef", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.k8s.CrossVersionObjectReference.class));
this.minReplicas = software.amazon.jsii.Kernel.get(this, "minReplicas", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.targetCpuUtilizationPercentage = software.amazon.jsii.Kernel.get(this, "targetCpuUtilizationPercentage", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.maxReplicas = java.util.Objects.requireNonNull(builder.maxReplicas, "maxReplicas is required");
this.scaleTargetRef = java.util.Objects.requireNonNull(builder.scaleTargetRef, "scaleTargetRef is required");
this.minReplicas = builder.minReplicas;
this.targetCpuUtilizationPercentage = builder.targetCpuUtilizationPercentage;
}
@Override
public final java.lang.Number getMaxReplicas() {
return this.maxReplicas;
}
@Override
public final org.cdk8s.plus31.k8s.CrossVersionObjectReference getScaleTargetRef() {
return this.scaleTargetRef;
}
@Override
public final java.lang.Number getMinReplicas() {
return this.minReplicas;
}
@Override
public final java.lang.Number getTargetCpuUtilizationPercentage() {
return this.targetCpuUtilizationPercentage;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("maxReplicas", om.valueToTree(this.getMaxReplicas()));
data.set("scaleTargetRef", om.valueToTree(this.getScaleTargetRef()));
if (this.getMinReplicas() != null) {
data.set("minReplicas", om.valueToTree(this.getMinReplicas()));
}
if (this.getTargetCpuUtilizationPercentage() != null) {
data.set("targetCpuUtilizationPercentage", om.valueToTree(this.getTargetCpuUtilizationPercentage()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk8s-plus-31.k8s.HorizontalPodAutoscalerSpec"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
HorizontalPodAutoscalerSpec.Jsii$Proxy that = (HorizontalPodAutoscalerSpec.Jsii$Proxy) o;
if (!maxReplicas.equals(that.maxReplicas)) return false;
if (!scaleTargetRef.equals(that.scaleTargetRef)) return false;
if (this.minReplicas != null ? !this.minReplicas.equals(that.minReplicas) : that.minReplicas != null) return false;
return this.targetCpuUtilizationPercentage != null ? this.targetCpuUtilizationPercentage.equals(that.targetCpuUtilizationPercentage) : that.targetCpuUtilizationPercentage == null;
}
@Override
public final int hashCode() {
int result = this.maxReplicas.hashCode();
result = 31 * result + (this.scaleTargetRef.hashCode());
result = 31 * result + (this.minReplicas != null ? this.minReplicas.hashCode() : 0);
result = 31 * result + (this.targetCpuUtilizationPercentage != null ? this.targetCpuUtilizationPercentage.hashCode() : 0);
return result;
}
}
}