v1beta1

Documentation

Index

• type CategoryFilter
  • func (cf *CategoryFilter) Create(m map[string]interface{})
  • func (cf *CategoryFilter) Get(db *database.Handler) ([]entity.Entity, int64, int, error)
  • func (cf *CategoryFilter) GetById(db *database.Handler) (entity.Entity, error)
• type ComponentFilter
  • func (cf *ComponentFilter) Create(m map[string]interface{})
  • func (componentFilter *ComponentFilter) Get(db *database.Handler) ([]entity.Entity, int64, int, error)
  • func (cf *ComponentFilter) GetById(db *database.Handler) (entity.Entity, error)
• type ModelFilter
  • func (mf *ModelFilter) Create(m map[string]interface{})
  • func (mf *ModelFilter) Get(db *database.Handler) ([]entity.Entity, int64, int, error)
  • func (mf *ModelFilter) GetById(db *database.Handler) (entity.Entity, error)
• type PolicyFilter
  • func (pf *PolicyFilter) Create(m map[string]interface{})
  • func (pf *PolicyFilter) Get(db *database.Handler) ([]entity.Entity, int64, int, error)
  • func (pf *PolicyFilter) GetById(db *database.Handler) (entity.Entity, error)

Types

type CategoryFilter

type CategoryFilter struct {
	Id      string
	Name    string
	OrderOn string
	Greedy  bool
	Sort    string //asc or desc. Default behavior is asc
	Limit   int    //If 0 or  unspecified then all records are returned and limit is not used
	Offset  int
}

func (*CategoryFilter) Create

func (cf *CategoryFilter) Create(m map[string]interface{})

Create the filter from map[string]interface{}

func (*CategoryFilter) Get

func (cf *CategoryFilter) Get(db *database.Handler) ([]entity.Entity, int64, int, error)

func (*CategoryFilter) GetById

func (cf *CategoryFilter) GetById(db *database.Handler) (entity.Entity, error)

type ComponentFilter

type ComponentFilter struct {
	Id           string
	Name         string
	APIVersion   string
	Greedy       bool //when set to true - instead of an exact match, name will be matched as a substring
	Trim         bool //when set to true - the schema is not returned
	DisplayName  string
	ModelName    string
	CategoryName string
	Version      string
	Sort         string //asc or desc. Default behavior is asc
	OrderOn      string
	Limit        int //If 0 or  unspecified then all records are returned and limit is not used
	Offset       int
	Annotations  string //When this query parameter is "true", only components with the "isAnnotation" property set to true are returned. When this query parameter is "false", all components except those considered to be annotation components are returned. Any other value of the query parameter results in both annotations as well as non-annotation models being returned.
	Status       string
}

func (*ComponentFilter) Create

func (cf *ComponentFilter) Create(m map[string]interface{})

Create the filter from map[string]interface{}

func (*ComponentFilter) Get

func (componentFilter *ComponentFilter) Get(db *database.Handler) ([]entity.Entity, int64, int, error)

func (*ComponentFilter) GetById

func (cf *ComponentFilter) GetById(db *database.Handler) (entity.Entity, error)

type ModelFilter

type ModelFilter struct {
	Id          string
	Name        string
	Registrant  string //name of the registrant for a given model
	DisplayName string //If Name is already passed, avoid passing Display name unless greedy=true, else the filter will translate to an AND returning only the models where name and display name match exactly. Ignore, if this behavior is expected.
	Greedy      bool   //when set to true - instead of an exact match, name will be prefix matched. Also an OR will be performed of name and display_name
	Version     string
	Category    string
	OrderOn     string
	Sort        string //asc or desc. Default behavior is asc
	Limit       int    //If 0 or unspecified then all records are returned and limit is not used
	Offset      int
	Annotations string //When this query parameter is "true", only models with the "isAnnotation" property set to true are returned. When  this query parameter is "false", all models except those considered to be annotation models are returned. Any other value of the query parameter results in both annoations as well as non-annotation models being returned.

	// When these are set to true, we also retrieve components/relationships associated with the model.
	Components    bool
	Relationships bool
	Status        string
	// When Trim is true it will only send necessary models data
	// like: component count, relationship count, id and name of model
	Trim bool
}

func (*ModelFilter) Create

func (mf *ModelFilter) Create(m map[string]interface{})

Create the filter from map[string]interface{}

func (*ModelFilter) Get

func (mf *ModelFilter) Get(db *database.Handler) ([]entity.Entity, int64, int, error)

func (*ModelFilter) GetById

func (mf *ModelFilter) GetById(db *database.Handler) (entity.Entity, error)

type PolicyFilter

type PolicyFilter struct {
	Id        string
	Kind      string
	Greedy    bool
	SubType   string
	ModelName string
	OrderOn   string
	Sort      string
	Limit     int
	Offset    int
}

func (*PolicyFilter) Create

func (pf *PolicyFilter) Create(m map[string]interface{})

func (*PolicyFilter) Get

func (pf *PolicyFilter) Get(db *database.Handler) ([]entity.Entity, int64, int, error)

func (*PolicyFilter) GetById

func (pf *PolicyFilter) GetById(db *database.Handler) (entity.Entity, error)