Package org.cdk8s.plus24.k8s

Class MetricSpecV2Beta1.Builder

java.lang.Object

org.cdk8s.plus24.k8s.MetricSpecV2Beta1.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MetricSpecV2Beta1>

Enclosing interface:

MetricSpecV2Beta1

@Stability(Stable)
public static final class MetricSpecV2Beta1.Builder
extends Object
implements software.amazon.jsii.Builder<MetricSpecV2Beta1>

A builder for MetricSpecV2Beta1

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MetricSpecV2Beta1	build()	Builds the configured instance.
MetricSpecV2Beta1.Builder	containerResource(ContainerResourceMetricSourceV2Beta1 containerResource)	Sets the value of MetricSpecV2Beta1.getContainerResource()
MetricSpecV2Beta1.Builder	external(ExternalMetricSourceV2Beta1 external)	Sets the value of MetricSpecV2Beta1.getExternal()
MetricSpecV2Beta1.Builder	object(ObjectMetricSourceV2Beta1 object)	Sets the value of MetricSpecV2Beta1.getObject()
MetricSpecV2Beta1.Builder	pods(PodsMetricSourceV2Beta1 pods)	Sets the value of MetricSpecV2Beta1.getPods()
MetricSpecV2Beta1.Builder	resource(ResourceMetricSourceV2Beta1 resource)	Sets the value of MetricSpecV2Beta1.getResource()
MetricSpecV2Beta1.Builder	type(String type)	Sets the value of MetricSpecV2Beta1.getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

type

@Stability(Stable)
public MetricSpecV2Beta1.Builder type(String type)

Sets the value of MetricSpecV2Beta1.getType()

Parameters:

type - type is the type of metric source. This parameter is required. 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

Returns:

this

containerResource

@Stability(Stable)
public MetricSpecV2Beta1.Builder containerResource(ContainerResourceMetricSourceV2Beta1 containerResource)

Sets the value of MetricSpecV2Beta1.getContainerResource()

Parameters:

containerResource - container resource 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.

Returns:

this

external

@Stability(Stable)
public MetricSpecV2Beta1.Builder external(ExternalMetricSourceV2Beta1 external)

Sets the value of MetricSpecV2Beta1.getExternal()

Parameters:

external - 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).

Returns:

this

object

@Stability(Stable)
public MetricSpecV2Beta1.Builder object(ObjectMetricSourceV2Beta1 object)

Sets the value of MetricSpecV2Beta1.getObject()

Parameters:

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

Returns:

this

pods

@Stability(Stable)
public MetricSpecV2Beta1.Builder pods(PodsMetricSourceV2Beta1 pods)

Sets the value of MetricSpecV2Beta1.getPods()

Parameters:

pods - 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.

Returns:

this

resource

@Stability(Stable)
public MetricSpecV2Beta1.Builder resource(ResourceMetricSourceV2Beta1 resource)

Sets the value of MetricSpecV2Beta1.getResource()

Parameters:

resource - 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.

Returns:

this

build

@Stability(Stable)
public MetricSpecV2Beta1 build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<MetricSpecV2Beta1>

Returns:

a new instance of MetricSpecV2Beta1

Throws:

NullPointerException - if any required attribute was not provided