options

Documentation

Index

• type CaseOptions
• type Options
  • func (o *Options) Clone() *Options

Types

type CaseOptions

type CaseOptions struct {
	// Matches indicates the values matching the rule execution's output that apply to this case
	Matches []string `toml:"matches"`
	// ReqRewriterName is the name of a configured Rewriter that will modify the request in this case
	// prior to handing off to the NextRoute
	ReqRewriterName string `toml:"req_rewriter_name"`
	// NextRoute is the name of the next OriginConfig destination for the request in this case
	NextRoute string `toml:"next_route"`
	// RedirectURL provides a URL to redirect the request in this case, rather than
	// handing off to the NextRoute
	RedirectURL string `toml:"redirect_url"`
}

CaseOptions defines the options for a given evaluation case

type Options

type Options struct {
	// Name provides the name of the Rule
	Name string `toml:"-"`
	// NextRoute indicates the name of the next OriginConfig destination for the request when
	// none of the cases are met following the execution of the rule
	NextRoute string `toml:"next_route"`
	// IngressReqRewriterName is the name of a configured Rewriter that will modify the request prior
	// to the rule taking any other action
	IngressReqRewriterName string `toml:"ingress_req_rewriter_name"`
	// EgressReqRewriterName is the name of a configured Rewriter that will modify the request once
	// all other rule actions have occurred, prior to the request being passed to the next route
	EgressReqRewriterName string `toml:"egress_req_rewriter_name"`
	// NoMatchReqRewriterName is the name of a configured Rewriter that will modify the request once
	// all other rule actions have occurred, and only if the Request did not match any defined case,
	// prior to the request being passed to the next route
	NoMatchReqRewriterName string `toml:"nomatch_req_rewriter_name"`
	//
	// Input source specifies the data source used when executing the rule. Possible options:
	//  Source           Example Source Used
	//  url              https://example.com:8480/path1/path2?param1=value
	//  url_no_params    https://example.com:8480/path1/path2
	//  scheme           https
	//  host             example.com:8480
	//  hostname         example.com
	//  port             8480 (80 and 443 are auto-set based on scheme when no port is provided)
	//  path             /path1/path2
	//  params           ?param1=value
	//  param            [must be used with InputKey as described below]
	//  header           [must be used with InputKey as described below]
	InputSource string `toml:"input_source"`
	//
	// InputKey is optional and provides extra information for locating the data source
	// when the InputSource is header or param, the input key must be the target header or param name
	InputKey string `toml:"input_key"`
	// InputType is optional, defaulting to string, and indicates the type of input:
	// string, num (treated internally as float64), or bool
	InputType string `toml:"input_type"`
	// InputEncoding is optional, defaulting to ”, and defines any special encoding format on
	// the input. Supported Options are: 'base64'
	InputEncoding string `toml:"input_encoding"`
	// InputIndex is optional, defaulting to -1 (no parts / use full string), and indicates which part
	// of the Input contains the specific value to which this rule applies. InputIndex is zero-based.
	InputIndex int `toml:"input_index"`
	// InputDelimiter is optional, defaulting to " ", and indicates the delimiter for separating the Input
	// into parts. This value has no effect unless InputIndex >= 0
	InputDelimiter string `toml:"input_delimiter"`
	//
	// Operation specifies what action to take on the input, whose result is used to
	// determine if any case is matched. Possible options are as follows.
	// string:   eq, contains, suffix, prefix, md5, sha1, base64, modulo
	// num:      eq, gt, lt, ge, le, bt (inclusive), modulo
	// bool:     eq
	// any boolean operation (everything but md5, sha1, base64, modulo) can be prefixed with !
	Operation string `toml:"operation"`
	//
	// OperationArg is optional and provides extra information used when performing the
	// configured Operation, such as the demonimator when the operation is modulus
	OperationArg string `toml:"operation_arg"`
	// RuleCaseOptions is the map of cases to apply to evaluate against this rule
	CaseOptions map[string]*CaseOptions `toml:"cases"`
	// RedirectURL provides a URL to redirect the request in the default case, rather than
	// handing off to the NextRoute
	RedirectURL string `toml:"redirect_url"`
	// MaxRuleExecutions limits the maximum number of per-Request rule-based hops so as to avoid
	// execution loops.
	MaxRuleExecutions int `toml:"max_rule_executions"`
}

Options defines the options for a Rule

func (*Options) Clone

func (o *Options) Clone() *Options

Clone returns a perfect copy of the subject *Options