custom_metrics

Documentation

Overview

+k8s:deepcopy-gen=package,register +groupName=custom-metrics.metrics.k8s.io

Index

• Constants
• Variables
• func DeepCopy_custom_metrics_MetricValue(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_custom_metrics_MetricValueList(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_custom_metrics_ObjectReference(in interface{}, out interface{}, c *conversion.Cloner) error
• func Kind(kind string) schema.GroupKind
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• type MetricValue
  • func (x *MetricValue) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *MetricValue) CodecEncodeSelf(e *codec1978.Encoder)
• type MetricValueList
  • func (x *MetricValueList) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *MetricValueList) CodecEncodeSelf(e *codec1978.Encoder)
• type ObjectReference
  • func (x *ObjectReference) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *ObjectReference) CodecEncodeSelf(e *codec1978.Encoder)

Constants

const AllObjects = "*"

allObjects is a wildcard used to select metrics for all objects matching the given label selector

const GroupName = "custom-metrics.metrics.k8s.io"

GroupName is the group name use in this package

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func DeepCopy_custom_metrics_MetricValue

func DeepCopy_custom_metrics_MetricValue(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_custom_metrics_MetricValue is an autogenerated deepcopy function.

func DeepCopy_custom_metrics_MetricValueList

func DeepCopy_custom_metrics_MetricValueList(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_custom_metrics_MetricValueList is an autogenerated deepcopy function.

func DeepCopy_custom_metrics_ObjectReference

func DeepCopy_custom_metrics_ObjectReference(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_custom_metrics_ObjectReference is an autogenerated deepcopy function.

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

Types

type MetricValue

type MetricValue struct {
	metav1.TypeMeta `json:",inline"`

	// a reference to the described object
	DescribedObject ObjectReference `json:"describedObject"`

	// the name of the metric
	MetricName string `json:"metricName"`

	// indicates the time at which the metrics were produced
	Timestamp metav1.Time `json:"timestamp"`

	// indicates the window ([Timestamp-Window, Timestamp]) from
	// which these metrics were calculated, when returning rate
	// metrics calculated from cumulative metrics (or zero for
	// non-calculated instantaneous metrics).
	WindowSeconds *int64 `json:"window,omitempty"`

	// the value of the metric for this
	Value resource.Quantity `json:"value"`
}

a metric value for some object

func (*MetricValue) CodecDecodeSelf

func (x *MetricValue) CodecDecodeSelf(d *codec1978.Decoder)

func (*MetricValue) CodecEncodeSelf

func (x *MetricValue) CodecEncodeSelf(e *codec1978.Encoder)

type MetricValueList

type MetricValueList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// the value of the metric across the described objects
	Items []MetricValue `json:"items"`
}

a list of values for a given metric for some set of objects

func (*MetricValueList) CodecDecodeSelf

func (x *MetricValueList) CodecDecodeSelf(d *codec1978.Decoder)

func (*MetricValueList) CodecEncodeSelf

func (x *MetricValueList) CodecEncodeSelf(e *codec1978.Encoder)

type ObjectReference

type ObjectReference struct {
	Kind            string
	Namespace       string
	Name            string
	UID             types.UID
	APIVersion      string
	ResourceVersion string
	FieldPath       string
}

ObjectReference contains enough information to let you inspect or modify the referred object.

func (*ObjectReference) CodecDecodeSelf

func (x *ObjectReference) CodecDecodeSelf(d *codec1978.Decoder)

func (*ObjectReference) CodecEncodeSelf

func (x *ObjectReference) CodecEncodeSelf(e *codec1978.Encoder)