type NewPutRuleset func(rulesetidstring) *PutRuleset

funcNewPutRulesetFunc¶

func NewPutRulesetFunc(tpelastictransport.Interface)NewPutRuleset

NewPutRulesetFunc returns a new instance of PutRuleset with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.

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

funcNew¶

func New(tpelastictransport.Interface) *PutRuleset

Create or update a query ruleset.There is a limit of 100 rules per ruleset.This limit can be increased by using the`xpack.applications.rules.max_rules_per_ruleset` cluster setting.

IMPORTANT: Due to limitations within pinned queries, you can only selectdocuments using `ids` or `docs`, but cannot use both in single rule.It is advised to use one or the other in query rulesets, to avoid errors.Additionally, pinned queries have a maximum limit of 100 pinned hits.If multiple matching rules pin more than 100 documents, only the first 100documents are pinned in the order they are specified in the ruleset.

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

func (PutRuleset)Do¶

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

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

func (*PutRuleset)ErrorTrace¶

func (r *PutRuleset) ErrorTrace(errortracebool) *PutRuleset

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

func (*PutRuleset)FilterPath¶

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

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

func (*PutRuleset)Header¶

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

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

func (*PutRuleset)HttpRequest¶

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

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

func (*PutRuleset)Human¶

func (r *PutRuleset) Human(humanbool) *PutRuleset

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 (PutRuleset)Perform¶

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

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

func (*PutRuleset)Pretty¶

func (r *PutRuleset) Pretty(prettybool) *PutRuleset

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

func (*PutRuleset)Raw¶

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

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

func (*PutRuleset)Request¶

func (r *PutRuleset) Request(req *Request) *PutRuleset

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

func (*PutRuleset)Rules¶

func (r *PutRuleset) Rules(rules ...types.QueryRule) *PutRuleset

API name: rules

type Request struct {Rules []types.QueryRule `json:"rules"`}

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

func (*Request)UnmarshalJSON¶

func (s *Request) UnmarshalJSON(data []byte)error

type Response struct {Resultresult.Result `json:"result"`}

funcNewResponse¶

func NewResponse() *Response

NewResponse returns a Response