ruleset

Documentation

Overview

# The MIT License (MIT) # # Copyright (c) 2019 Carbon Black # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in all # copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE.

Index

• type Rule
  • func (r *Rule) AddCache(cacheFunc *plg.PluginInterface, opName string) *Rule
  • func (r *Rule) AddCacheStep(step *rl.Step, isMulti bool) *Rule
  • func (r *Rule) AddEmptyPredicate() *Rule
  • func (r *Rule) AddPredicate(step *rl.Step) *Rule
  • func (r *Rule) AddProjectStep(step *rl.Step, isMulti bool) *Rule
  • func (r *Rule) AddProjection() *Rule
  • func (r *Rule) AddStep(step *rl.Step, isMulti bool) *Rule
  • func (r *Rule) GetRule(name string, metricSender *metrics.SfxClient) rl.Rulebase
  • func (r *Rule) InitRule() *Rule
  • func (r *Rule) OrPredicate(step *rl.Step, isMulti bool) *Rule
  • func (r *Rule) SetDestination(destPlugin *plg.IOPluginInterface, worker interface{}) *Rule

Types

type Rule

type Rule struct {
	// contains filtered or unexported fields
}

Implementation of the Builder pattern for the Rules

func (*Rule) AddCache

func (r *Rule) AddCache(cacheFunc *plg.PluginInterface, opName string) *Rule

func (*Rule) AddCacheStep

func (r *Rule) AddCacheStep(step *rl.Step, isMulti bool) *Rule

func (*Rule) AddEmptyPredicate

func (r *Rule) AddEmptyPredicate() *Rule

func (*Rule) AddPredicate

func (r *Rule) AddPredicate(step *rl.Step) *Rule

Adds a Predicate; yes there can be multiple predicates that each have their own set of 'steps'

func (*Rule) AddProjectStep

func (r *Rule) AddProjectStep(step *rl.Step, isMulti bool) *Rule

Adds a Projection step

func (*Rule) AddProjection

func (r *Rule) AddProjection() *Rule

Adds a Projection

func (*Rule) AddStep

func (r *Rule) AddStep(step *rl.Step, isMulti bool) *Rule

Adds a step to a Predicate

func (*Rule) GetRule

func (r *Rule) GetRule(name string, metricSender *metrics.SfxClient) rl.Rulebase

This returns the rule

func (*Rule) InitRule

func (r *Rule) InitRule() *Rule

the Predicate and Projections all have steps that need to be performed so they will be stored in a list

func (*Rule) OrPredicate

func (r *Rule) OrPredicate(step *rl.Step, isMulti bool) *Rule

adds a step to another to complete an 'OR' statement

func (*Rule) SetDestination

func (r *Rule) SetDestination(destPlugin *plg.IOPluginInterface, worker interface{}) *Rule

This is making the destination explicit and easy to retrieve