The highest tagged major version is
Documentation
¶
Overview ¶
Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.
When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.
Index ¶
- Variables
- type NewPutSynonym
- type PutSynonym
- func (r PutSynonym) Do(providedCtx context.Context) (*Response, error)
- func (r *PutSynonym) ErrorTrace(errortrace bool) *PutSynonym
- func (r *PutSynonym) FilterPath(filterpaths ...string) *PutSynonym
- func (r *PutSynonym) Header(key, value string) *PutSynonym
- func (r *PutSynonym) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutSynonym) Human(human bool) *PutSynonym
- func (r PutSynonym) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutSynonym) Pretty(pretty bool) *PutSynonym
- func (r *PutSynonym) Raw(raw io.Reader) *PutSynonym
- func (r *PutSynonym) Request(req *Request) *PutSynonym
- func (r *PutSynonym) SynonymsSet(synonymssets ...types.SynonymRule) *PutSynonym
- 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 NewPutSynonym ¶
type NewPutSynonym func(id string) *PutSynonym
NewPutSynonym type alias for index.
func NewPutSynonymFunc ¶
func NewPutSynonymFunc(tp elastictransport.Interface) NewPutSynonym
NewPutSynonymFunc returns a new instance of PutSynonym with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PutSynonym ¶
type PutSynonym struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PutSynonym
Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.
When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.
https://www.elastic.co/guide/en/elasticsearch/reference/current/put-synonyms-set.html
func (PutSynonym) Do ¶
func (r PutSynonym) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a putsynonym.Response
func (*PutSynonym) ErrorTrace ¶ added in v8.14.0
func (r *PutSynonym) ErrorTrace(errortrace bool) *PutSynonym
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*PutSynonym) FilterPath ¶ added in v8.14.0
func (r *PutSynonym) FilterPath(filterpaths ...string) *PutSynonym
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*PutSynonym) Header ¶
func (r *PutSynonym) Header(key, value string) *PutSynonym
Header set a key, value pair in the PutSynonym headers map.
func (*PutSynonym) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutSynonym) Human ¶ added in v8.14.0
func (r *PutSynonym) Human(human bool) *PutSynonym
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 (PutSynonym) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutSynonym) Pretty ¶ added in v8.14.0
func (r *PutSynonym) Pretty(pretty bool) *PutSynonym
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*PutSynonym) Raw ¶
func (r *PutSynonym) Raw(raw io.Reader) *PutSynonym
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PutSynonym) Request ¶
func (r *PutSynonym) Request(req *Request) *PutSynonym
Request allows to set the request property with the appropriate payload.
func (*PutSynonym) SynonymsSet ¶
func (r *PutSynonym) SynonymsSet(synonymssets ...types.SynonymRule) *PutSynonym
SynonymsSet The synonym rules definitions for the synonyms set. API name: synonyms_set
type Request ¶
type Request struct {
// SynonymsSet The synonym rules definitions for the synonyms set.
SynonymsSet []types.SynonymRule `json:"synonyms_set"`
}
Request holds the request body struct for the package putsynonym
Source Files