Documentation
¶
Overview ¶
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 pin 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 NewPutRule
- type PutRule
- func (r *PutRule) Actions(actions types.QueryRuleActionsVariant) *PutRule
- func (r *PutRule) Criteria(criteria ...types.QueryRuleCriteriaVariant) *PutRule
- func (r PutRule) Do(providedCtx context.Context) (*Response, error)
- func (r *PutRule) ErrorTrace(errortrace bool) *PutRule
- func (r *PutRule) FilterPath(filterpaths ...string) *PutRule
- func (r *PutRule) Header(key, value string) *PutRule
- func (r *PutRule) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutRule) Human(human bool) *PutRule
- func (r PutRule) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutRule) Pretty(pretty bool) *PutRule
- func (r *PutRule) Priority(priority int) *PutRule
- func (r *PutRule) Raw(raw io.Reader) *PutRule
- func (r *PutRule) Request(req *Request) *PutRule
- func (r *PutRule) Type(type_ queryruletype.QueryRuleType) *PutRule
- type Request
- type Response
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 NewPutRule ¶
NewPutRule type alias for index.
func NewPutRuleFunc ¶
func NewPutRuleFunc(tp elastictransport.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 ¶
type PutRule struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.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 pin 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-rule
func (*PutRule) Actions ¶
func (r *PutRule) Actions(actions types.QueryRuleActionsVariant) *PutRule
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.QueryRuleCriteriaVariant) *PutRule
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. API name: criteria
func (PutRule) Do ¶
Do runs the request through the transport, handle the response and returns a putrule.Response
func (*PutRule) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*PutRule) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*PutRule) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutRule) 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 (PutRule) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutRule) Pretty ¶
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*PutRule) Raw ¶
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PutRule) Type ¶
func (r *PutRule) Type(type_ queryruletype.QueryRuleType) *PutRule
The type of rule. API name: type
type Request ¶
type Request struct {
// Actions The actions to take when the rule is matched.
// The format of this action depends on the rule type.
Actions types.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.
Type queryruletype.QueryRuleType `json:"type"`
}
Request holds the request body struct for the package putrule
Source Files