Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Constraint ¶ added in v0.0.3
type Constraint struct {
// End of time interval, quoted RFC 3339 format.
// Format: date-time
End *strfmt.DateTime `json:"end,omitempty"`
// Limit number of objects returned per query, <=0 means no limit.
Limit int64 `json:"limit,omitempty"`
// Start of time interval, quoted RFC 3339 format.
// Format: date-time
Start *strfmt.DateTime `json:"start,omitempty"`
// Timeout per request, h/m/s/ms/ns format
Timeout string `json:"timeout,omitempty"`
}
Constraint Constraint constrains the objects that will be included in search results.
swagger:model Constraint
func (*Constraint) ContextValidate ¶ added in v0.0.3
ContextValidate validates this constraint based on context it is used
func (*Constraint) MarshalBinary ¶ added in v0.0.3
func (m *Constraint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Constraint) UnmarshalBinary ¶ added in v0.0.3
func (m *Constraint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Domain ¶
type Domain struct {
// Name of the domain.
Name string `json:"name,omitempty"`
// Stores configured for the domain.
Stores []Store `json:"stores"`
}
Domain Domain configuration information.
swagger:model Domain
func (*Domain) ContextValidate ¶
ContextValidate validate this domain based on the context it is used
func (*Domain) MarshalBinary ¶
MarshalBinary interface implementation
func (*Domain) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Edge ¶
type Edge struct {
// Goal is the class name of the goal node.
// Example: domain:class
Goal string `json:"goal,omitempty"`
// Rules is the set of rules followed along this edge.
Rules []*Rule `json:"rules,omitempty"`
// Start is the class name of the start node.
Start string `json:"start,omitempty"`
}
Edge Directed edge in the result graph, from Start to Goal classes.
swagger:model Edge
func (*Edge) ContextValidate ¶
ContextValidate validate this edge based on the context it is used
func (*Edge) MarshalBinary ¶
MarshalBinary interface implementation
func (*Edge) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Goals ¶
type Goals struct {
// Goal classes for correlation.
// Example: ["domain:class"]
Goals []string `json:"goals"`
// start
Start *Start `json:"start,omitempty"`
}
Goals Starting point for a goals search.
swagger:model Goals
func (*Goals) ContextValidate ¶
ContextValidate validate this goals based on the context it is used
func (*Goals) MarshalBinary ¶
MarshalBinary interface implementation
func (*Goals) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Graph ¶
Graph Graph resulting from a correlation search.
swagger:model Graph
func (*Graph) ContextValidate ¶
ContextValidate validate this graph based on the context it is used
func (*Graph) MarshalBinary ¶
MarshalBinary interface implementation
func (*Graph) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Neighbours ¶
type Neighbours struct {
// Max depth of neighbours graph.
Depth int64 `json:"depth,omitempty"`
// start
Start *Start `json:"start,omitempty"`
}
Neighbours Starting point for a neighbours search.
swagger:model Neighbours
func (*Neighbours) ContextValidate ¶
ContextValidate validate this neighbours based on the context it is used
func (*Neighbours) MarshalBinary ¶
func (m *Neighbours) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Neighbours) UnmarshalBinary ¶
func (m *Neighbours) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Node ¶
type Node struct {
// Class is the full class name in "DOMAIN:CLASS" form.
// Example: domain:class
Class string `json:"class,omitempty"`
// Count of results found for this class, after de-duplication.
Count int64 `json:"count,omitempty"`
// Queries yielding results for this class.
Queries []*QueryCount `json:"queries"`
}
Node Node in the result graph, contains results for a single class.
swagger:model Node
func (*Node) ContextValidate ¶
ContextValidate validate this node based on the context it is used
func (*Node) MarshalBinary ¶
MarshalBinary interface implementation
func (*Node) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type QueryCount ¶
type QueryCount struct {
// Count of results or -1 if the query was not executed.
Count int64 `json:"count,omitempty"`
// Query for correlation data.
Query string `json:"query,omitempty"`
}
QueryCount Query run during a correlation with a count of results found.
swagger:model QueryCount
func (*QueryCount) ContextValidate ¶
ContextValidate validates this query count based on context it is used
func (*QueryCount) MarshalBinary ¶
func (m *QueryCount) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*QueryCount) UnmarshalBinary ¶
func (m *QueryCount) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Rule ¶
type Rule struct {
// Name is an optional descriptive name.
Name string `json:"name,omitempty"`
// Queries generated while following this rule.
Queries []*QueryCount `json:"queries"`
}
Rule Rule is a correlation rule with a list of queries and results counts found during navigation.
swagger:model Rule
func (*Rule) ContextValidate ¶
ContextValidate validate this rule based on the context it is used
func (*Rule) MarshalBinary ¶
MarshalBinary interface implementation
func (*Rule) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Start ¶
type Start struct {
// Class for `objects`
Class string `json:"class,omitempty"`
// constraint
Constraint *Constraint `json:"constraint,omitempty"`
// Objects of `class` serialized as JSON
Objects interface{} `json:"objects,omitempty"`
// Queries for starting objects
Queries []string `json:"queries"`
}
Start Start identifies a set of starting objects for correlation.
swagger:model Start
func (*Start) ContextValidate ¶
ContextValidate validate this start based on the context it is used
func (*Start) MarshalBinary ¶
MarshalBinary interface implementation
func (*Start) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Store ¶
Store Store is a map of name:value attributes used to connect to a store.
swagger:model Store
func (Store) ContextValidate ¶
ContextValidate validates this store based on context it is used