getsynonymrule

Documentation

Overview

Retrieves a synonym rule from a synonym set

Index

• Variables
• type GetSynonymRule
  • func New(tp elastictransport.Interface) *GetSynonymRule
  • func (r GetSynonymRule) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetSynonymRule) Header(key, value string) *GetSynonymRule
  • func (r *GetSynonymRule) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetSynonymRule) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetSynonymRule) Perform(providedCtx context.Context) (*http.Response, error)
• type NewGetSynonymRule
  • func NewGetSynonymRuleFunc(tp elastictransport.Interface) NewGetSynonymRule
• 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 GetSynonymRule

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

func New

func New(tp elastictransport.Interface) *GetSynonymRule

Retrieves a synonym rule from a synonym set

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-synonym-rule.html

func (GetSynonymRule) Do

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

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

func (*GetSynonymRule) Header

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

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

func (*GetSynonymRule) HttpRequest

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

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

func (GetSynonymRule) IsSuccess

func (r GetSynonymRule) 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 (GetSynonymRule) Perform

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

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

type NewGetSynonymRule

type NewGetSynonymRule func(setid, ruleid string) *GetSynonymRule

NewGetSynonymRule type alias for index.

func NewGetSynonymRuleFunc

func NewGetSynonymRuleFunc(tp elastictransport.Interface) NewGetSynonymRule

NewGetSynonymRuleFunc returns a new instance of GetSynonymRule 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 {

	// Id Synonym Rule identifier
	Id string `json:"id"`
	// Synonyms Synonyms, in Solr format, that conform the synonym rule. See
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2
	Synonyms string `json:"synonyms"`
}

Response holds the response body struct for the package getsynonymrule

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/synonyms/get_synonym_rule/SynonymRuleGetResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response