model

type Attribute struct {
	// The name of an attribute, must be unique for the resource level and cannot be null or empty.
	Name         promModel.LabelName
	StringRecord `yaml:",inline" json:",inline"`
}

type AttributeSchema struct {
	Name     promModel.LabelName // id
	Brief    string              // comment
	Type     string              // string,int...
	Required bool
}

type HistoricalAttribute struct {
	Name    promModel.LabelName `json:",omitempty"`
	Records []*StringRecord     `json:",omitempty"`
}

type HistoricalRelation struct {
	RelationName         `json:",inline" yaml:",inline"`
	SourceUrn, TargetUrn string
	Records              []*RelationChangedRecord
}

type HistoricalResource struct {
	Type         TypeName   `json:",omitempty"` // Related with resource's type, and the type connected with a specification.
	Urn          string     `json:",omitempty"` // The Unique resource name of this resources, must be unique with whole scope.
	ObserveTypes []TypeName `json:",omitempty"` // Additional type of resource, used for observability.

	Attributes []*HistoricalAttribute `json:",omitempty"` // Attributes of the resource, may be a required or optional.
	State      *HistoricalState       `json:",omitempty"` // State of the resource, name should be unique.
}

type HistoricalState struct {
	Name    promModel.LabelName
	Records []*StateRecord
}

type Relation struct {
	RelationName          `json:",inline" yaml:",inline"`
	SourceUrn, TargetUrn  string
	RelationChangedRecord `json:",inline" yaml:",inline"`
}

type RelationChangedRecord struct {
	Since promModel.Time // The time of relation created.
	EndUp promModel.Time // The time of relation finished.
}

type RelationConditionSchema struct {
	SourceAttribute promModel.LabelName
	TargetAttribute promModel.LabelName
}

type RelationName struct {
	Name, Source, Target TypeName
}

type RelationSchema struct {
	Name           promModel.LabelName
	Brief          string
	Source, Target ResourceSchema
	Conditions     []*RelationConditionSchema
}

type Resource struct {
	Type         TypeName     `json:",omitempty"` // Related with resource's type, and the type connected with a specification.
	Urn          string       `json:",omitempty"` // The Unique resource name of this resources, must be unique with whole scope.
	ObserveTypes []TypeName   `json:",omitempty"` // Additional type of resource, used for observability.
	Attributes   []*Attribute `json:",omitempty"` // Attributes of the resource, may be a required or optional.
	States       *State       `json:",omitempty"` // State of the resource, name should be unique.
}

type ResourceMatcher struct {
	Type     TypeName
	Matchers []*labels.Matcher `json:",omitempty" yaml:",omitempty"`
}

type ResourceQuery struct {
	Time      promModel.Time
	Selectors []*ResourceSelector `json:",omitempty" yaml:",omitempty"`
}

type ResourceQueryRange struct {
	Start     promModel.Time
	End       promModel.Time
	Selectors []*ResourceSelector `json:",omitempty" yaml:",omitempty"`
}

type ResourceQueryRangeResponse struct {
	Resources map[TypeName][]HistoricalResource `json:",omitempty" yaml:",omitempty"`
	Relations map[TypeName][]HistoricalRelation `json:",omitempty" yaml:",omitempty"`
}

type ResourceQueryResponse struct {
	Resources map[TypeName][]Resource `json:",omitempty" yaml:",omitempty"`
	Relations map[TypeName][]Relation `json:",omitempty" yaml:",omitempty"`
}

type ResourceSchema struct {
	Name        TypeName
	Brief       string
	Prefix      string
	UrnPattern  string // UrnPattern is a NamedRegex that can be used transform urn from attributes.
	ShowPattern string // ShowPattern is a short name pattern for represent
	Attributes  []*AttributeSchema
}

type ResourceSelector struct {
	// SourceMatcher Start point of resource searching, required.
	SourceMatcher *ResourceMatcher `json:",omitempty" yaml:",omitempty"`
	// TargetMatcher Endpoint of resource searching, required.
	TargetMatcher *ResourceMatcher `json:",omitempty" yaml:",omitempty"`
	// ShowState return the resource with global state.
	ShowState bool
	// Relations return more resources that match the relation of Matcher, optional.
	Relations []*RelationName `json:",omitempty" yaml:",omitempty"`
}

type State struct {
	Name        promModel.LabelName // The name of the state, must be unique in the resource level and cannot be null or empty.
	StateRecord `json:",inline" yaml:",inline"`
}

type StateQuery struct {
	Time      promModel.Time
	Selectors []*StateSelector
}

type StateQueryRange struct {
	Start   promModel.Time
	End     promModel.Time
	Matcher ResourceMatcher

	// States selector of stateName
	States labels.Matcher
}

type StateQueryRangeResponse struct {
	Content map[string][]*HistoricalState
}

type StateQueryResponse struct {
	Content map[string][]*State
}

type StateRecord struct {
	Since promModel.Time `json:",omitempty"` // The time of state value change to.
	EndUp promModel.Time `json:",omitempty"` // The time of state value change to.
	Value StateValue     // The value of the state, must be match StateValue.
}

type StateSelector struct {
	// Matcher Start point of resource searching, required.
	Matcher ResourceMatcher

	// States selector of stateName
	States labels.Matcher
}

type StateValue int

type StringRecord struct {
	Since promModel.Time       `json:",omitempty"` // The time of the value change to.
	EndUp promModel.Time       `json:",omitempty"` // The time of relation finished.
	Value promModel.LabelValue // The value, cannot be null or empty.
}

type TypeName string