Documentation
¶
Overview ¶
Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.
Index ¶
- Variables
- type NewTest
- type Request
- type Response
- type Test
- func (r *Test) AddMatchCriterion(key string, value json.RawMessage) *Test
- func (r Test) Do(providedCtx context.Context) (*Response, error)
- func (r *Test) ErrorTrace(errortrace bool) *Test
- func (r *Test) FilterPath(filterpaths ...string) *Test
- func (r *Test) Header(key, value string) *Test
- func (r *Test) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Test) Human(human bool) *Test
- func (r *Test) MatchCriteria(matchcriteria map[string]json.RawMessage) *Test
- func (r Test) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Test) Pretty(pretty bool) *Test
- func (r *Test) Raw(raw io.Reader) *Test
- func (r *Test) Request(req *Request) *Test
Constants ¶
This section is empty.
Variables ¶
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")
ErrBuildPath is returned in case of missing parameters within the build of the request.
Functions ¶
This section is empty.
Types ¶
type NewTest ¶
NewTest type alias for index.
func NewTestFunc ¶
func NewTestFunc(tp elastictransport.Interface) NewTest
NewTestFunc returns a new instance of Test with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// MatchCriteria The match criteria to apply to rules in the given query ruleset.
// Match criteria should match the keys defined in the `criteria.metadata` field
// of the rule.
MatchCriteria map[string]json.RawMessage `json:"match_criteria"`
}
Request holds the request body struct for the package test
type Response ¶
type Response struct {
MatchedRules []types.QueryRulesetMatchedRule `json:"matched_rules"`
TotalMatchedRules int `json:"total_matched_rules"`
}
Response holds the response body struct for the package test
type Test ¶
type Test struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Test
Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-test
func (*Test) AddMatchCriterion ¶
func (r *Test) AddMatchCriterion(key string, value json.RawMessage) *Test
func (Test) Do ¶
Do runs the request through the transport, handle the response and returns a test.Response
func (*Test) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Test) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Test) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Test) Human ¶
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (*Test) MatchCriteria ¶
func (r *Test) MatchCriteria(matchcriteria map[string]json.RawMessage) *Test
The match criteria to apply to rules in the given query ruleset. Match criteria should match the keys defined in the `criteria.metadata` field of the rule. API name: match_criteria
func (Test) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Test) Pretty ¶
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
Source Files