framework

type Filter interface {
	// The Filter will filter resource can`t be recommended via target recommender.
	Filter(ctx *RecommendationContext) error
}

type ObjectIdentity struct {
	Namespace  string
	APIVersion string
	Kind       string
	Name       string
	Labels     map[string]string
	Object     unstructured.Unstructured
}

type Observe interface {
	Observe(ctx *RecommendationContext) error
}

type PostPrepare interface {
	PostProcessing(ctx *RecommendationContext) error
}

type PostRecommend interface {
	Policy(ctx *RecommendationContext) error
}

type PrePrepare interface {
	CheckDataProviders(ctx *RecommendationContext) error
}

type PreRecommend interface {
	PreRecommend(ctx *RecommendationContext) error
}

type Prepare interface {
	CollectData(ctx *RecommendationContext) error
}

type Recommend interface {
	Recommend(ctx *RecommendationContext) error
}

type RecommendationContext struct {
	Context context.Context
	// The kubernetes resource object reference of recommendation flow.
	Identity ObjectIdentity
	// Target Object
	Object client.Object
	// Time series data from data source.
	InputValues []*common.TimeSeries
	// Time series data 2 from data source.
	InputValues2 []*common.TimeSeries
	// Result series from prediction
	ResultValues []*common.TimeSeries
	// DataProviders contains data source of your recommendation flow.
	DataProviders map[providers.DataSourceType]providers.History
	// Recommendation store result of recommendation flow.
	Recommendation *v1alpha1.Recommendation
	// When cancel channel accept signal indicates that the context has been canceled. The recommendation should stop executing as soon as possible.
	// CancelCh <-chan struct{}
	// RecommendationRule for the context
	RecommendationRule *v1alpha1.RecommendationRule
	// metrics namer for datasource provider
	MetricNamer metricnaming.MetricNamer
	// Algorithm Config
	AlgorithmConfig *config.Config
	// Manager of predict algorithm
	PredictorMgr predictormgr.Manager
	// Pod template
	PodTemplate corev1.PodTemplateSpec
	// Client
	Client client.Client
	// RestMapper
	RestMapper meta.RESTMapper
	// ScalesGetter
	ScaleClient scale.ScalesGetter
	// Scale
	Scale *autoscalingapiv1.Scale
	// Pods in recommendation
	Pods []corev1.Pod
	// HPA Object
	HPA *autoscalingv2.HorizontalPodAutoscaler
	// HPA Object
	EHPA *autoscalingapi.EffectiveHorizontalPodAutoscaler
}