type NewPutRule func(rulesetid, ruleidstring) *PutRule

funcNewPutRuleFunc¶

func NewPutRuleFunc(tpelastictransport.Interface)NewPutRule

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

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

funcNew¶

func New(tpelastictransport.Interface) *PutRule

Create or update a query rule.Create or update a query rule within a query ruleset.

IMPORTANT: Due to limitations within pinned queries, you can only pindocuments 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-rule.html

func (*PutRule)Actions¶

func (r *PutRule) Actions(actions *types.QueryRuleActions) *PutRule

Actions The actions to take when the rule is matched.The format of this action depends on the rule type.API name: actions

func (*PutRule)Criteria¶

func (r *PutRule) Criteria(criteria ...types.QueryRuleCriteria) *PutRule

Criteria The criteria that must be met for the rule to be applied.If multiple criteria are specified for a rule, all criteria must be met forthe rule to be applied.API name: criteria

func (PutRule)Do¶

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

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

func (*PutRule)ErrorTrace¶

func (r *PutRule) ErrorTrace(errortracebool) *PutRule

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

func (*PutRule)FilterPath¶

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

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

func (*PutRule)Header¶

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

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

func (*PutRule)HttpRequest¶

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

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

func (*PutRule)Human¶

func (r *PutRule) Human(humanbool) *PutRule

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

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

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

func (*PutRule)Pretty¶

func (r *PutRule) Pretty(prettybool) *PutRule

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

func (*PutRule)Priority¶

func (r *PutRule) Priority(priorityint) *PutRule

API name: priority

func (*PutRule)Raw¶

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

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

func (*PutRule)Request¶

func (r *PutRule) Request(req *Request) *PutRule

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

func (*PutRule)Type¶

func (r *PutRule) Type(type_queryruletype.QueryRuleType) *PutRule

Type The type of rule.API name: type

type Request struct {// Actions The actions to take when the rule is matched.// The format of this action depends on the rule type.Actionstypes.QueryRuleActions `json:"actions"`// Criteria The criteria that must be met for the rule to be applied.// If multiple criteria are specified for a rule, all criteria must be met for// the rule to be applied.Criteria []types.QueryRuleCriteria `json:"criteria"`Priority *int                      `json:"priority,omitempty"`// Type The type of rule.Typequeryruletype.QueryRuleType `json:"type"`}

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