Package org.cdk8s.plus24.k8s

Interface MetricSpecV2

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MetricSpecV2.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-24T11:18:28.977Z")
@Stability(Stable)
public interface MetricSpecV2
extends software.amazon.jsii.JsiiSerializable

MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MetricSpecV2.Builder	builder()
default ContainerResourceMetricSourceV2	getContainerResource()	containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g.
default ExternalMetricSourceV2	getExternal()	external refers to a global metric that is not associated with any Kubernetes object.
default ObjectMetricSourceV2	getObject()	object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).
default PodsMetricSourceV2	getPods()	pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second).
default ResourceMetricSourceV2	getResource()	resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g.
String	getType()	type is the type of metric source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getType

@Stability(Stable)
@NotNull
String getType()

type is the type of metric source.

It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled

getContainerResource

@Stability(Stable)
@Nullable
default ContainerResourceMetricSourceV2 getContainerResource()

containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag.

getExternal

@Stability(Stable)
@Nullable
default ExternalMetricSourceV2 getExternal()

external refers to a global metric that is not associated with any Kubernetes object.

It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).

getObject

@Stability(Stable)
@Nullable
default ObjectMetricSourceV2 getObject()

object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object).

getPods

@Stability(Stable)
@Nullable
default PodsMetricSourceV2 getPods()

pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

The values will be averaged together before being compared to the target value.

getResource

@Stability(Stable)
@Nullable
default ResourceMetricSourceV2 getResource()

resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

builder

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

Returns:

a MetricSpecV2.Builder of MetricSpecV2