v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API.

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type ResourceMetricsMonitor
  • func (in *ResourceMetricsMonitor) DeepCopy() *ResourceMetricsMonitor
  • func (in *ResourceMetricsMonitor) DeepCopyInto(out *ResourceMetricsMonitor)
  • func (in *ResourceMetricsMonitor) DeepCopyObject() runtime.Object
• type ResourceMetricsMonitorList
  • func (in *ResourceMetricsMonitorList) DeepCopy() *ResourceMetricsMonitorList
  • func (in *ResourceMetricsMonitorList) DeepCopyInto(out *ResourceMetricsMonitorList)
  • func (in *ResourceMetricsMonitorList) DeepCopyObject() runtime.Object
• type ResourceMetricsMonitorSpec
  • func (in *ResourceMetricsMonitorSpec) DeepCopy() *ResourceMetricsMonitorSpec
  • func (in *ResourceMetricsMonitorSpec) DeepCopyInto(out *ResourceMetricsMonitorSpec)
• type ResourceMetricsMonitorStatus
  • func (in *ResourceMetricsMonitorStatus) DeepCopy() *ResourceMetricsMonitorStatus
  • func (in *ResourceMetricsMonitorStatus) DeepCopyInto(out *ResourceMetricsMonitorStatus)
  • func (status *ResourceMetricsMonitorStatus) Set(resource *ResourceMetricsMonitor, condition metav1.Condition)

Constants

const (

	// ConditionTypeProcessed represents the condition type for a resource that has been processed successfully.
	ConditionTypeProcessed = iota

	// ConditionTypeFailed represents the condition type for resource that has failed to process further.
	ConditionTypeFailed
)

Variables

var (
	// SchemeBuilder initializes a scheme builder
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme
)

var (

	// ConditionType is a slice of strings representing the condition types.
	ConditionType = []string{"Processed", "Failed"}

	// ConditionMessageTrue is a group of condition messages applicable when the associated condition status is true.
	ConditionMessageTrue = []string{
		"Resource configuration has been processed successfully",
		"Resource failed to process",
	}

	// ConditionMessageFalse is a group of condition messages applicable when the associated condition status is false.
	ConditionMessageFalse = []string{
		"Resource configuration is yet to be processed",
		"N/A",
	}

	// ConditionReasonTrue is a group of condition reasons applicable when the associated condition status is true.
	ConditionReasonTrue = []string{"EventHandlerSucceeded", "EventHandlerFailed"}

	// ConditionReasonFalse is a group of condition reasons applicable when the associated condition status is false.
	ConditionReasonFalse = []string{"EventHandlerRunning", "N/A"}
)

var SchemeGroupVersion = schema.GroupVersion{Group: resourcestatemetrics.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

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

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type ResourceMetricsMonitor

type ResourceMetricsMonitor struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              ResourceMetricsMonitorSpec   `json:"spec"`
	Status            ResourceMetricsMonitorStatus `json:"status,omitempty"`
}

ResourceMetricsMonitor is a specification for a ResourceMetricsMonitor resource.

func (*ResourceMetricsMonitor) DeepCopy

func (in *ResourceMetricsMonitor) DeepCopy() *ResourceMetricsMonitor

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceMetricsMonitor.

func (*ResourceMetricsMonitor) DeepCopyInto

func (in *ResourceMetricsMonitor) DeepCopyInto(out *ResourceMetricsMonitor)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceMetricsMonitor) DeepCopyObject

func (in *ResourceMetricsMonitor) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceMetricsMonitorList

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

	Items []ResourceMetricsMonitor `json:"items"`
}

ResourceMetricsMonitorList is a list of ResourceMetricsMonitor resources.

func (*ResourceMetricsMonitorList) DeepCopy

func (in *ResourceMetricsMonitorList) DeepCopy() *ResourceMetricsMonitorList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceMetricsMonitorList.

func (*ResourceMetricsMonitorList) DeepCopyInto

func (in *ResourceMetricsMonitorList) DeepCopyInto(out *ResourceMetricsMonitorList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceMetricsMonitorList) DeepCopyObject

func (in *ResourceMetricsMonitorList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceMetricsMonitorSpec

type ResourceMetricsMonitorSpec struct {

	// Configuration is the RSM configuration that generates metrics.
	Configuration string `json:"configuration"`
}

ResourceMetricsMonitorSpec is the spec for a ResourceMetricsMonitor resource.

func (*ResourceMetricsMonitorSpec) DeepCopy

func (in *ResourceMetricsMonitorSpec) DeepCopy() *ResourceMetricsMonitorSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceMetricsMonitorSpec.

func (*ResourceMetricsMonitorSpec) DeepCopyInto

func (in *ResourceMetricsMonitorSpec) DeepCopyInto(out *ResourceMetricsMonitorSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceMetricsMonitorStatus

type ResourceMetricsMonitorStatus struct {

	// Conditions is an array of conditions associated with the resource.
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

ResourceMetricsMonitorStatus is the status for a ResourceMetricsMonitor resource.

func (*ResourceMetricsMonitorStatus) DeepCopy

func (in *ResourceMetricsMonitorStatus) DeepCopy() *ResourceMetricsMonitorStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceMetricsMonitorStatus.

func (*ResourceMetricsMonitorStatus) DeepCopyInto

func (in *ResourceMetricsMonitorStatus) DeepCopyInto(out *ResourceMetricsMonitorStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceMetricsMonitorStatus) Set

func (status *ResourceMetricsMonitorStatus) Set(
	resource *ResourceMetricsMonitor,
	condition metav1.Condition,
)

Set sets the given condition for the resource.