MetricSpec class

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

Constructors

MetricSpec({ContainerResourceMetricSource? containerResource, ExternalMetricSource? external, ObjectMetricSource? object, PodsMetricSource? pods, ResourceMetricSource? resource, required String type})

The main constructor.

const

MetricSpec.fromJson(Map<String, dynamic> json)

Creates a MetricSpec from JSON data.

Properties

containerResource → ContainerResourceMetricSource?

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.

final

external → ExternalMetricSource?

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

final

hashCode → int

The hash code for this object.

no setter, inherited

object → ObjectMetricSource?

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

final

pods → PodsMetricSource?

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.

final

resource → ResourceMetricSource?

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.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

type → String

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.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object>

Converts a MetricSpec instance to JSON data.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

listFromJson(Iterable<Map<String, dynamic>> list) → List<MetricSpec>

Creates a list of MetricSpec from JSON data.