getruleset

Documentation

Overview

Get a query ruleset. Get details about a query ruleset.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetRuleset

Get a query ruleset. Get details about a query ruleset.

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

func (GetRuleset) Do

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

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

func (*GetRuleset) ErrorTrace

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

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

func (*GetRuleset) FilterPath

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

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

func (*GetRuleset) Header

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

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

func (*GetRuleset) HttpRequest

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

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

func (*GetRuleset) Human

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

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

func (r GetRuleset) 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 (GetRuleset) Perform

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

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

func (*GetRuleset) Pretty

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

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

type NewGetRuleset

type NewGetRuleset func(rulesetid string) *GetRuleset

NewGetRuleset type alias for index.

func NewGetRulesetFunc

func NewGetRulesetFunc(tp elastictransport.Interface) NewGetRuleset

NewGetRulesetFunc returns a new instance of GetRuleset 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 {

	// Rules Rules associated with the query ruleset
	Rules []types.QueryRule `json:"rules"`
	// RulesetId Query Ruleset unique identifier
	RulesetId string `json:"ruleset_id"`
}

Response holds the response body struct for the package getruleset

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/query_rules/get_ruleset/QueryRulesetGetResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response