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

• func AddRecordRule(name string, rule string)
• func AddRule(name string, rule string, checkpoint bool)
• func CountFunctions(rule string) int
• func DeleteRule(name string)
• func FindFuncRecursive(rule string, builder *bldr.Rule, isProject string, realID string, isMulti int, ...) (bool, bool, *plg.PluginInterface, string)
• func FindFunction(rule string) (operator *plg.PluginInterface, args string, err error)
• func FindInitPredicate(record string) (plugin *plg.IOPluginInterface, remainder string, worker interface{}, err error)
• func FindOperator(rule string) (operator *plg.PluginInterface, err error)
• func GetFunction(funcName string) *plg.PluginInterface
• func GetOperationSteps(rule string, operator *plg.PluginInterface, builder *bldr.Rule, isOr bool) (result bool, err error)
• func InitRecordRuleset() *map[string]*rl.Rulebase
• func InitWorkerRuleset(shardID string) (*map[string]*rl.Rulebase, int)
• func LoadDestinationPlugins()
• func LoadOperatorPlugins()
• func LoadRules()
• func PullPluginsAndRules(rulesetName string, path string)
• func RuleMatch(rule *rl.Rulebase, record string) (bool, []byte, error)
• func RunRecordRules()
• type DestConfigs
• type OpConfigs
• type RuleConfigs

Functions

func AddRecordRule

func AddRecordRule(name string, rule string)

func AddRule

func AddRule(name string, rule string, checkpoint bool)

Adds a rule.

func CountFunctions

func CountFunctions(rule string) int

func DeleteRule

func DeleteRule(name string)

func FindFuncRecursive

func FindFuncRecursive(rule string, builder *bldr.Rule, isProject string, realID string, isMulti int, isOr bool) (bool, bool, *plg.PluginInterface, string)

func FindFunction

func FindFunction(rule string) (operator *plg.PluginInterface, args string, err error)

func FindInitPredicate

func FindInitPredicate(record string) (plugin *plg.IOPluginInterface, remainder string, worker interface{}, err error)

finds the type of destination, initialize it

func FindOperator

func FindOperator(rule string) (operator *plg.PluginInterface, err error)

func GetFunction

func GetFunction(funcName string) *plg.PluginInterface

func GetOperationSteps

func GetOperationSteps(rule string, operator *plg.PluginInterface, builder *bldr.Rule, isOr bool) (result bool, err error)

func InitRecordRuleset

func InitRecordRuleset() *map[string]*rl.Rulebase

func InitWorkerRuleset

func InitWorkerRuleset(shardID string) (*map[string]*rl.Rulebase, int)

func LoadDestinationPlugins

func LoadDestinationPlugins()

loads all the destinations

func LoadOperatorPlugins

func LoadOperatorPlugins()

loads everything else

func LoadRules

func LoadRules()

loads all the destinations

func PullPluginsAndRules

func PullPluginsAndRules(rulesetName string, path string)

func RuleMatch

func RuleMatch(rule *rl.Rulebase, record string) (bool, []byte, error)

func RunRecordRules

func RunRecordRules()

Types

type DestConfigs

type DestConfigs struct {
	DestRegion    string
	DestBucket    string
	DestS3Path    string
	DestLocalPath string
}

type OpConfigs

type OpConfigs struct {
	OpRegion    string
	OpBucket    string
	OpS3Path    string
	OpLocalPath string
}

type RuleConfigs

type RuleConfigs struct {
	RuleRegion    string
	RuleBucket    string
	RulesetS3Path string
	RulesS3Path   string
}