Documentation
¶
Overview ¶
Creates or updates a synonym rule in a synonym set
Index ¶
- Variables
- type NewPutSynonymRule
- type PutSynonymRule
- func (r PutSynonymRule) Do(providedCtx context.Context) (*Response, error)
- func (r *PutSynonymRule) Header(key, value string) *PutSynonymRule
- func (r *PutSynonymRule) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r PutSynonymRule) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutSynonymRule) Raw(raw io.Reader) *PutSynonymRule
- func (r *PutSynonymRule) Request(req *Request) *PutSynonymRule
- func (r *PutSynonymRule) Synonyms(synonymstring string) *PutSynonymRule
- 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 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) Header ¶
func (r *PutSynonymRule) Header(key, value string) *PutSynonymRule
Header set a key, value pair in the PutSynonymRule headers map.
func (*PutSynonymRule) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (PutSynonymRule) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
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
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
Source Files