getrule

Documentation

Overview

Returns the details about a query rule within a query ruleset

Index

• Variables
• type GetRule
  • func New(tp elastictransport.Interface) *GetRule
  • func (r GetRule) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetRule) ErrorTrace(errortrace bool) *GetRule
  • func (r *GetRule) FilterPath(filterpaths ...string) *GetRule
  • func (r *GetRule) Header(key, value string) *GetRule
  • func (r *GetRule) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetRule) Human(human bool) *GetRule
  • func (r GetRule) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetRule) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetRule) Pretty(pretty bool) *GetRule
• type NewGetRule
  • func NewGetRuleFunc(tp elastictransport.Interface) NewGetRule
• 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 GetRule

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

func New

func New(tp elastictransport.Interface) *GetRule

Returns the details about a query rule within a query ruleset

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-query-rule.html

func (GetRule) Do

func (r GetRule) Do(providedCtx context.Context) (*Response, error)

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

func (*GetRule) ErrorTrace

func (r *GetRule) ErrorTrace(errortrace bool) *GetRule

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

func (*GetRule) FilterPath

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

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

func (*GetRule) Header

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

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

func (*GetRule) HttpRequest

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

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

func (*GetRule) Human

func (r *GetRule) Human(human bool) *GetRule

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 (GetRule) IsSuccess

func (r GetRule) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (GetRule) Perform

func (r GetRule) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*GetRule) Pretty

func (r *GetRule) Pretty(pretty bool) *GetRule

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

type NewGetRule

type NewGetRule func(rulesetid, ruleid string) *GetRule

NewGetRule type alias for index.

func NewGetRuleFunc

func NewGetRuleFunc(tp elastictransport.Interface) NewGetRule

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

type Response

type Response struct {
	Actions  types.QueryRuleActions      `json:"actions"`
	Criteria []types.QueryRuleCriteria   `json:"criteria"`
	Priority *int                        `json:"priority,omitempty"`
	RuleId   string                      `json:"rule_id"`
	Type     queryruletype.QueryRuleType `json:"type"`
}

Response holds the response body struct for the package getrule

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/query_rules/get_rule/QueryRuleGetResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response