putsynonymrule

Documentation

Overview

Creates or updates a synonym rule in a synonym set

Index

• Variables
• type NewPutSynonymRule
  • func NewPutSynonymRuleFunc(tp elastictransport.Interface) NewPutSynonymRule
• type PutSynonymRule
  • func New(tp elastictransport.Interface) *PutSynonymRule
  • func (r PutSynonymRule) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutSynonymRule) ErrorTrace(errortrace bool) *PutSynonymRule
  • func (r *PutSynonymRule) FilterPath(filterpaths ...string) *PutSynonymRule
  • func (r *PutSynonymRule) Header(key, value string) *PutSynonymRule
  • func (r *PutSynonymRule) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutSynonymRule) Human(human bool) *PutSynonymRule
  • func (r PutSynonymRule) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutSynonymRule) Pretty(pretty bool) *PutSynonymRule
  • func (r *PutSynonymRule) Raw(raw io.Reader) *PutSynonymRule
  • func (r *PutSynonymRule) Request(req *Request) *PutSynonymRule
  • func (r *PutSynonymRule) Synonyms(synonymstring string) *PutSynonymRule
• 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 NewPutSynonymRule

type NewPutSynonymRule func(setid, ruleid string) *PutSynonymRule

NewPutSynonymRule type alias for index.

func NewPutSynonymRuleFunc

func NewPutSynonymRuleFunc(tp elastictransport.Interface) NewPutSynonymRule

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

type PutSynonymRule

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

func New

func New(tp elastictransport.Interface) *PutSynonymRule

Creates or updates a synonym rule in a synonym set

https://www.elastic.co/guide/en/elasticsearch/reference/current/put-synonym-rule.html

func (PutSynonymRule) Do

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

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

func (*PutSynonymRule) ErrorTrace

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

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

func (*PutSynonymRule) FilterPath

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

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

func (*PutSynonymRule) Header

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

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

func (*PutSynonymRule) HttpRequest

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

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

func (*PutSynonymRule) Human

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

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 (PutSynonymRule) Perform

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

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

func (*PutSynonymRule) Pretty

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

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

func (*PutSynonymRule) Raw

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

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

func (*PutSynonymRule) Request

func (r *PutSynonymRule) Request(req *Request) *PutSynonymRule

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

func (*PutSynonymRule) Synonyms

func (r *PutSynonymRule) Synonyms(synonymstring string) *PutSynonymRule

API name: synonyms

type Request

type Request struct {
	Synonyms string `json:"synonyms"`
}

Request holds the request body struct for the package putsynonymrule

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/synonyms/put_synonym_rule/SynonymRulePutRequest.ts#L23-L47

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 {

	// ReloadAnalyzersDetails Updating synonyms in a synonym set reloads the associated analyzers.
	// This is the analyzers reloading result
	ReloadAnalyzersDetails types.ReloadResult `json:"reload_analyzers_details"`
	// Result Update operation result
	Result result.Result `json:"result"`
}

Response holds the response body struct for the package putsynonymrule

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/synonyms/put_synonym_rule/SynonymRulePutResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response