getsynonym

Documentation

Overview

Retrieves a synonym set

Index

• Variables
• type GetSynonym
  • func New(tp elastictransport.Interface) *GetSynonym
  • func (r GetSynonym) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetSynonym) From(from int) *GetSynonym
  • func (r *GetSynonym) Header(key, value string) *GetSynonym
  • func (r *GetSynonym) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetSynonym) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetSynonym) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetSynonym) Size(size int) *GetSynonym
• type NewGetSynonym
  • func NewGetSynonymFunc(tp elastictransport.Interface) NewGetSynonym
• 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 GetSynonym

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

func New

func New(tp elastictransport.Interface) *GetSynonym

Retrieves a synonym set

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-synonyms-set.html

func (GetSynonym) Do

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

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

func (*GetSynonym) From

func (r *GetSynonym) From(from int) *GetSynonym

From Starting offset for query rules to be retrieved API name: from

func (*GetSynonym) Header

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

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

func (*GetSynonym) HttpRequest

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

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

func (GetSynonym) IsSuccess

func (r GetSynonym) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (GetSynonym) Perform

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

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

func (*GetSynonym) Size

func (r *GetSynonym) Size(size int) *GetSynonym

Size specifies a max number of query rules to retrieve API name: size

type NewGetSynonym

type NewGetSynonym func(id string) *GetSynonym

NewGetSynonym type alias for index.

func NewGetSynonymFunc

func NewGetSynonymFunc(tp elastictransport.Interface) NewGetSynonym

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

type Response

type Response struct {
	Count       int                     `json:"count"`
	SynonymsSet []types.SynonymRuleRead `json:"synonyms_set"`
}

Response holds the response body struct for the package getsynonym

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/synonyms/get_synonym/SynonymsGetResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response