putruleset

Documentation

Overview

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 select documents 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 100 documents are pinned in the order they are specified in the ruleset.

Index

• Variables
• type NewPutRuleset
  • func NewPutRulesetFunc(tp elastictransport.Interface) NewPutRuleset
• type PutRuleset
  • func New(tp elastictransport.Interface) *PutRuleset
  • func (r PutRuleset) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutRuleset) ErrorTrace(errortrace bool) *PutRuleset
  • func (r *PutRuleset) FilterPath(filterpaths ...string) *PutRuleset
  • func (r *PutRuleset) Header(key, value string) *PutRuleset
  • func (r *PutRuleset) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutRuleset) Human(human bool) *PutRuleset
  • func (r PutRuleset) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutRuleset) Pretty(pretty bool) *PutRuleset
  • func (r *PutRuleset) Raw(raw io.Reader) *PutRuleset
  • func (r *PutRuleset) Request(req *Request) *PutRuleset
  • func (r *PutRuleset) Rules(rules ...types.QueryRuleVariant) *PutRuleset
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response

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.

Types

type NewPutRuleset

type NewPutRuleset func(rulesetid string) *PutRuleset

NewPutRuleset type alias for index.

func NewPutRulesetFunc

func NewPutRulesetFunc(tp elastictransport.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

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

func New

func New(tp elastictransport.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 select documents 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 100 documents are pinned in the order they are specified in the ruleset.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-put-ruleset

func (PutRuleset) Do

func (r PutRuleset) Do(providedCtx context.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(errortrace bool) *PutRuleset

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when 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 response returned by Elasticsearch. API name: filter_path

func (*PutRuleset) Header

func (r *PutRuleset) Header(key, value string) *PutRuleset

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

func (*PutRuleset) HttpRequest

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

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

func (*PutRuleset) Human

func (r *PutRuleset) Human(human bool) *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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (PutRuleset) Perform

func (r PutRuleset) Perform(providedCtx context.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(pretty bool) *PutRuleset

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

func (*PutRuleset) Raw

func (r *PutRuleset) Raw(raw io.Reader) *PutRuleset

Raw takes a json payload as input which is then passed to the http.Request If 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.QueryRuleVariant) *PutRuleset

API name: rules

type Request

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

Request holds the request body struct for the package putruleset

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts#L23-L59

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*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

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

Response holds the response body struct for the package putruleset

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/query_rules/put_ruleset/QueryRulesetPutResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response