Class V2HorizontalPodAutoscalerSpec

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

Inheritance
object
V2HorizontalPodAutoscalerSpec
Implements
Inherited Members
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V2HorizontalPodAutoscalerSpec : IEquatable<V2HorizontalPodAutoscalerSpec>

Constructors

View Source

V2HorizontalPodAutoscalerSpec()

Declaration
public V2HorizontalPodAutoscalerSpec()
View Source

V2HorizontalPodAutoscalerSpec(V2HorizontalPodAutoscalerSpec)

Declaration
protected V2HorizontalPodAutoscalerSpec(V2HorizontalPodAutoscalerSpec original)
Parameters
Type Name Description
V2HorizontalPodAutoscalerSpec original

Properties

View Source

Behavior

behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.

Declaration
[JsonPropertyName("behavior")]
public V2HorizontalPodAutoscalerBehavior Behavior { get; set; }
Property Value
Type Description
V2HorizontalPodAutoscalerBehavior
View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

MaxReplicas

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

Declaration
[JsonPropertyName("maxReplicas")]
public int MaxReplicas { get; set; }
Property Value
Type Description
int
View Source

Metrics

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.

Declaration
[JsonPropertyName("metrics")]
public IList<V2MetricSpec> Metrics { get; set; }
Property Value
Type Description
IList<V2MetricSpec>
View Source

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.

Declaration
[JsonPropertyName("minReplicas")]
public int? MinReplicas { get; set; }
Property Value
Type Description
int?
View Source

ScaleTargetRef

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.

Declaration
[JsonPropertyName("scaleTargetRef")]
public V2CrossVersionObjectReference ScaleTargetRef { get; set; }
Property Value
Type Description
V2CrossVersionObjectReference

Methods

View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
View Source

Equals(V2HorizontalPodAutoscalerSpec?)

Declaration
public virtual bool Equals(V2HorizontalPodAutoscalerSpec? other)
Parameters
Type Name Description
V2HorizontalPodAutoscalerSpec other
Returns
Type Description
bool
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

View Source

operator ==(V2HorizontalPodAutoscalerSpec?, V2HorizontalPodAutoscalerSpec?)

Declaration
public static bool operator ==(V2HorizontalPodAutoscalerSpec? left, V2HorizontalPodAutoscalerSpec? right)
Parameters
Type Name Description
V2HorizontalPodAutoscalerSpec left
V2HorizontalPodAutoscalerSpec right
Returns
Type Description
bool
View Source

operator !=(V2HorizontalPodAutoscalerSpec?, V2HorizontalPodAutoscalerSpec?)

Declaration
public static bool operator !=(V2HorizontalPodAutoscalerSpec? left, V2HorizontalPodAutoscalerSpec? right)
Parameters
Type Name Description
V2HorizontalPodAutoscalerSpec left
V2HorizontalPodAutoscalerSpec right
Returns
Type Description
bool

Implements