type NewTest func(rulesetidstring) *Test

funcNewTestFunc¶

func NewTestFunc(tpelastictransport.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 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"`}

funcNewRequest¶

func NewRequest() *Request

NewRequest returns a Request

func (*Request)FromJSON¶

func (r *Request) FromJSON(datastring) (*Request,error)

FromJSON allows to load an arbitrary json into the request structure

type Response struct {MatchedRules      []types.QueryRulesetMatchedRule `json:"matched_rules"`TotalMatchedRulesint                             `json:"total_matched_rules"`}

funcNewResponse¶

func NewResponse() *Response

NewResponse returns a Response

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

funcNew¶

func New(tpelastictransport.Interface) *Test

Test a query ruleset.Evaluate match criteria against a query ruleset to identify the rules thatwould match that criteria.

https://www.elastic.co/guide/en/elasticsearch/reference/current/test-query-ruleset.html

func (Test)Do¶

func (rTest) Do(providedCtxcontext.Context) (*Response,error)

Do runs the request through the transport, handle the response and returns a test.Response

func (*Test)ErrorTrace¶

func (r *Test) ErrorTrace(errortracebool) *Test

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace

func (*Test)FilterPath¶

func (r *Test) FilterPath(filterpaths ...string) *Test

FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path

func (*Test)Header¶

func (r *Test) Header(key, valuestring) *Test

Header set a key, value pair in the Test headers map.

func (*Test)HttpRequest¶

func (r *Test) HttpRequest(ctxcontext.Context) (*http.Request,error)

HttpRequest returns the http.Request object built from thegiven parameters.

func (*Test)Human¶

func (r *Test) Human(humanbool) *Test

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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (*Test)MatchCriteria¶

func (r *Test) MatchCriteria(matchcriteria map[string]json.RawMessage) *Test

MatchCriteria The match criteria to apply to rules in the given query ruleset.Match criteria should match the keys defined in the `criteria.metadata` fieldof the rule.API name: match_criteria

func (Test)Perform¶

func (rTest) Perform(providedCtxcontext.Context) (*http.Response,error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Test)Pretty¶

func (r *Test) Pretty(prettybool) *Test

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty

func (*Test)Raw¶

func (r *Test) Raw(rawio.Reader) *Test

Raw takes a json payload as input which is then passed to the http.RequestIf specified Raw takes precedence on Request method.

func (*Test)Request¶

func (r *Test) Request(req *Request) *Test

Request allows to set the request property with the appropriate payload.