Package io.kubernetes.client.openapi.models

Class V2HorizontalPodAutoscalerSpec

java.lang.Object

io.kubernetes.client.openapi.models.V2HorizontalPodAutoscalerSpec

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-04-23T13:45:08.546919Z[Etc/UTC]")
public class V2HorizontalPodAutoscalerSpec
extends Object

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_BEHAVIOR
static final String	SERIALIZED_NAME_MAX_REPLICAS
static final String	SERIALIZED_NAME_METRICS
static final String	SERIALIZED_NAME_MIN_REPLICAS
static final String	SERIALIZED_NAME_SCALE_TARGET_REF

Constructor Summary

Constructors

Constructor	Description
V2HorizontalPodAutoscalerSpec()

Method Summary

Modifier and Type	Method	Description
V2HorizontalPodAutoscalerSpec	addMetricsItem(V2MetricSpec metricsItem)
V2HorizontalPodAutoscalerSpec	behavior(V2HorizontalPodAutoscalerBehavior behavior)
boolean	equals(Object o)
V2HorizontalPodAutoscalerBehavior	getBehavior()	Get behavior
Integer	getMaxReplicas()	maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up.
List<V2MetricSpec>	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).
Integer	getMinReplicas()	minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.
V2CrossVersionObjectReference	getScaleTargetRef()	Get scaleTargetRef
int	hashCode()
V2HorizontalPodAutoscalerSpec	maxReplicas(Integer maxReplicas)
V2HorizontalPodAutoscalerSpec	metrics(List<V2MetricSpec> metrics)
V2HorizontalPodAutoscalerSpec	minReplicas(Integer minReplicas)
V2HorizontalPodAutoscalerSpec	scaleTargetRef(V2CrossVersionObjectReference scaleTargetRef)
void	setBehavior(V2HorizontalPodAutoscalerBehavior behavior)
void	setMaxReplicas(Integer maxReplicas)
void	setMetrics(List<V2MetricSpec> metrics)
void	setMinReplicas(Integer minReplicas)
void	setScaleTargetRef(V2CrossVersionObjectReference scaleTargetRef)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_BEHAVIOR

public static final String SERIALIZED_NAME_BEHAVIOR

See Also:

• Constant Field Values

SERIALIZED_NAME_MAX_REPLICAS

public static final String SERIALIZED_NAME_MAX_REPLICAS

See Also:

• Constant Field Values

SERIALIZED_NAME_METRICS

public static final String SERIALIZED_NAME_METRICS

See Also:

• Constant Field Values

SERIALIZED_NAME_MIN_REPLICAS

public static final String SERIALIZED_NAME_MIN_REPLICAS

See Also:

• Constant Field Values

SERIALIZED_NAME_SCALE_TARGET_REF

public static final String SERIALIZED_NAME_SCALE_TARGET_REF

See Also:

• Constant Field Values

Constructor Details

V2HorizontalPodAutoscalerSpec

public V2HorizontalPodAutoscalerSpec()

Method Details

behavior

public V2HorizontalPodAutoscalerSpec behavior(V2HorizontalPodAutoscalerBehavior behavior)

getBehavior

@Nullable
public V2HorizontalPodAutoscalerBehavior getBehavior()

Get behavior

Returns:

behavior

setBehavior

public void setBehavior(V2HorizontalPodAutoscalerBehavior behavior)

maxReplicas

public V2HorizontalPodAutoscalerSpec maxReplicas(Integer maxReplicas)

getMaxReplicas

public Integer getMaxReplicas()

maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.

Returns:

maxReplicas

setMaxReplicas

public void setMaxReplicas(Integer maxReplicas)

metrics

public V2HorizontalPodAutoscalerSpec metrics(List<V2MetricSpec> metrics)

addMetricsItem

public V2HorizontalPodAutoscalerSpec addMetricsItem(V2MetricSpec metricsItem)

getMetrics

@Nullable
public List<V2MetricSpec> 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. If not set, the default metric will be set to 80% average CPU utilization.

Returns:

metrics

setMetrics

public void setMetrics(List<V2MetricSpec> metrics)

minReplicas

public V2HorizontalPodAutoscalerSpec minReplicas(Integer minReplicas)

getMinReplicas

@Nullable
public Integer 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.

Returns:

minReplicas

setMinReplicas

public void setMinReplicas(Integer minReplicas)

scaleTargetRef

public V2HorizontalPodAutoscalerSpec scaleTargetRef(V2CrossVersionObjectReference scaleTargetRef)

getScaleTargetRef

public V2CrossVersionObjectReference getScaleTargetRef()

Get scaleTargetRef

Returns:

scaleTargetRef

setScaleTargetRef

public void setScaleTargetRef(V2CrossVersionObjectReference scaleTargetRef)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object