models

package
v0.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 23, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

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

func (m *Constraint) ContextValidate(ctx context.Context, formats strfmt.Registry) error

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

func (*Constraint) Validate added in v0.0.3

func (m *Constraint) Validate(formats strfmt.Registry) error

Validate validates this constraint

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

func (m *Domain) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this domain based on the context it is used

func (*Domain) MarshalBinary

func (m *Domain) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Domain) UnmarshalBinary

func (m *Domain) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Domain) Validate

func (m *Domain) Validate(formats strfmt.Registry) error

Validate validates this domain

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

func (m *Edge) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this edge based on the context it is used

func (*Edge) MarshalBinary

func (m *Edge) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Edge) UnmarshalBinary

func (m *Edge) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Edge) Validate

func (m *Edge) Validate(formats strfmt.Registry) error

Validate validates this edge

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

func (m *Goals) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this goals based on the context it is used

func (*Goals) MarshalBinary

func (m *Goals) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Goals) UnmarshalBinary

func (m *Goals) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Goals) Validate

func (m *Goals) Validate(formats strfmt.Registry) error

Validate validates this goals

type Graph

type Graph struct {

	// edges
	Edges []*Edge `json:"edges"`

	// nodes
	Nodes []*Node `json:"nodes"`
}

Graph Graph resulting from a correlation search.

swagger:model Graph

func (*Graph) ContextValidate

func (m *Graph) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this graph based on the context it is used

func (*Graph) MarshalBinary

func (m *Graph) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Graph) UnmarshalBinary

func (m *Graph) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Graph) Validate

func (m *Graph) Validate(formats strfmt.Registry) error

Validate validates this graph

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

func (m *Neighbours) ContextValidate(ctx context.Context, formats strfmt.Registry) error

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

func (*Neighbours) Validate

func (m *Neighbours) Validate(formats strfmt.Registry) error

Validate validates this neighbours

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

func (m *Node) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this node based on the context it is used

func (*Node) MarshalBinary

func (m *Node) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Node) UnmarshalBinary

func (m *Node) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Node) Validate

func (m *Node) Validate(formats strfmt.Registry) error

Validate validates this node

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

func (m *QueryCount) ContextValidate(ctx context.Context, formats strfmt.Registry) error

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

func (*QueryCount) Validate

func (m *QueryCount) Validate(formats strfmt.Registry) error

Validate validates this query count

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

func (m *Rule) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this rule based on the context it is used

func (*Rule) MarshalBinary

func (m *Rule) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Rule) UnmarshalBinary

func (m *Rule) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Rule) Validate

func (m *Rule) Validate(formats strfmt.Registry) error

Validate validates this rule

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

func (m *Start) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this start based on the context it is used

func (*Start) MarshalBinary

func (m *Start) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Start) UnmarshalBinary

func (m *Start) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Start) Validate

func (m *Start) Validate(formats strfmt.Registry) error

Validate validates this start

type Store

type Store map[string]string

Store Store is a map of name:value attributes used to connect to a store.

swagger:model Store

func (Store) ContextValidate

func (m Store) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this store based on context it is used

func (Store) Validate

func (m Store) Validate(formats strfmt.Registry) error

Validate validates this store

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL