putsynonym

Documentation

Overview

Creates or updates a synonym set.

Index

• Variables
• type NewPutSynonym
  • func NewPutSynonymFunc(tp elastictransport.Interface) NewPutSynonym
• type PutSynonym
  • func New(tp elastictransport.Interface) *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
  • 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 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

Creates or updates a synonym 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

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

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

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

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

func (*PutSynonym) Human

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

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

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

func (*PutSynonym) Pretty

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 set information to update API name: synonyms_set

type Request

type Request struct {

	// SynonymsSet The synonym set information to update
	SynonymsSet []types.SynonymRule `json:"synonyms_set"`
}

Request holds the request body struct for the package putsynonym

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/synonyms/put_synonym/SynonymsPutRequest.ts#L23-L42

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 types.ReloadResult `json:"reload_analyzers_details"`
	Result                 result.Result      `json:"result"`
}

Response holds the response body struct for the package putsynonym

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/synonyms/put_synonym/SynonymsPutResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response