Package org.cdk8s.plus24.k8s

Interface HorizontalPodAutoscalerSpecV2Beta1

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HorizontalPodAutoscalerSpecV2Beta1.Jsii$Proxy

@Generated(value="jsii-pacmak/1.68.0 (build b45f2f6)",
           date="2022-09-25T03:33:25.486Z")
@Stability(Stable)
public interface HorizontalPodAutoscalerSpecV2Beta1
extends software.amazon.jsii.JsiiSerializable

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HorizontalPodAutoscalerSpecV2Beta1.Builder	A builder for HorizontalPodAutoscalerSpecV2Beta1
static class	HorizontalPodAutoscalerSpecV2Beta1.Jsii$Proxy	An implementation for HorizontalPodAutoscalerSpecV2Beta1

Method Summary

Modifier and Type	Method	Description
static HorizontalPodAutoscalerSpecV2Beta1.Builder	builder()
Number	getMaxReplicas()	maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up.
default List<MetricSpecV2Beta1>	getMetrics()	metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used).
default Number	getMinReplicas()	minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.
CrossVersionObjectReferenceV2Beta1	getScaleTargetRef()	scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMaxReplicas

@Stability(Stable)
@NotNull
Number getMaxReplicas()

maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up.

It cannot be less that minReplicas.

getScaleTargetRef

@Stability(Stable)
@NotNull
CrossVersionObjectReferenceV2Beta1 getScaleTargetRef()

scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.

getMetrics

@Stability(Stable)
@Nullable
default List<MetricSpecV2Beta1> getMetrics()

metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used).

The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond.

getMinReplicas

@Stability(Stable)
@Nullable
default Number getMinReplicas()

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.

builder

@Stability(Stable)
static HorizontalPodAutoscalerSpecV2Beta1.Builder builder()

Returns:

a HorizontalPodAutoscalerSpecV2Beta1.Builder of HorizontalPodAutoscalerSpecV2Beta1