putsynonym

package
v8.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 27, 2023 License: Apache-2.0 Imports: 12 Imported by: 2

Documentation

Overview

Creates or updates a synonyms set

Index

Constants

This section is empty.

Variables

View Source
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 (PutSynonym) Do

func (r PutSynonym) Do(ctx context.Context) (*Response, error)

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

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

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

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

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/5fea44e006349579bf3561a82e997002e5716117/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

type Response

type Response struct {
	ReloadAnalyzersDetails types.ReloadDetails `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/5fea44e006349579bf3561a82e997002e5716117/specification/synonyms/put_synonym/SynonymsPutResponse.ts#L24-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL