detectionrules

Documentation

Index

• Variables
• type ApiRule
  • func (me *ApiRule) MarshalHCL(properties hcl.Properties) error
  • func (me *ApiRule) Schema() map[string]*schema.Schema
  • func (me *ApiRule) UnmarshalHCL(decoder hcl.Decoder) error
• type ApiRules
  • func (me ApiRules) MarshalHCL(properties hcl.Properties) error
  • func (me *ApiRules) Schema() map[string]*schema.Schema
  • func (me *ApiRules) UnmarshalHCL(decoder hcl.Decoder) error
• type Base
• type Matcher
• type Settings
  • func (me *Settings) MarshalHCL(properties hcl.Properties) error
  • func (me *Settings) Name() string
  • func (me *Settings) Schema() map[string]*schema.Schema
  • func (me *Settings) UnmarshalHCL(decoder hcl.Decoder) error
• type Technology

Variables

var Bases = struct {
	FileName Base
	Fqcn     Base
	Package  Base
}{
	"FILE_NAME",
	"FQCN",
	"PACKAGE",
}

var Matchers = struct {
	BeginsWith Matcher
	Contains   Matcher
}{
	"BEGINS_WITH",
	"CONTAINS",
}

var Technologies = struct {
	Dotnet Technology
	Go     Technology
	Java   Technology
	Nodejs Technology
	Php    Technology
}{
	"dotNet",
	"Go",
	"Java",
	"Nodejs",
	"PHP",
}

Types

type ApiRule

type ApiRule struct {
	Base    Base    `json:"base"`    // Possible Values: `FILE_NAME`, `FQCN`, `PACKAGE`
	Matcher Matcher `json:"matcher"` // Possible Values: `BEGINS_WITH`, `CONTAINS`
	Pattern string  `json:"pattern"`
}

func (*ApiRule) MarshalHCL

func (me *ApiRule) MarshalHCL(properties hcl.Properties) error

func (*ApiRule) Schema

func (me *ApiRule) Schema() map[string]*schema.Schema

func (*ApiRule) UnmarshalHCL

func (me *ApiRule) UnmarshalHCL(decoder hcl.Decoder) error

type ApiRules

type ApiRules []*ApiRule

func (ApiRules) MarshalHCL

func (me ApiRules) MarshalHCL(properties hcl.Properties) error

func (*ApiRules) Schema

func (me *ApiRules) Schema() map[string]*schema.Schema

func (*ApiRules) UnmarshalHCL

func (me *ApiRules) UnmarshalHCL(decoder hcl.Decoder) error

type Base

type Base string

type Matcher

type Matcher string

type Settings

type Settings struct {
	ApiColor      string      `json:"apiColor"`             // This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
	ApiName       string      `json:"apiName"`              // API name
	Conditions    ApiRules    `json:"conditions,omitempty"` // List of conditions
	Technology    *Technology `json:"technology,omitempty"` // Restrict this rule to a specific technology.
	ThirdPartyApi bool        `json:"thirdPartyApi"`        // This API defines a third party library
}

func (*Settings) MarshalHCL

func (me *Settings) MarshalHCL(properties hcl.Properties) error

func (*Settings) Name

func (me *Settings) Name() string

func (*Settings) Schema

func (me *Settings) Schema() map[string]*schema.Schema

func (*Settings) UnmarshalHCL

func (me *Settings) UnmarshalHCL(decoder hcl.Decoder) error

type Technology

type Technology string