The highest tagged major version is
Documentation
¶
Overview ¶
Retrieves a synonym rule from a synonym set
Index ¶
- Variables
- type GetSynonymRule
- func (r GetSynonymRule) Do(ctx 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(ctx context.Context) (bool, error)
- func (r GetSynonymRule) Perform(ctx context.Context) (*http.Response, error)
- func (r *GetSynonymRule) RuleId(ruleid string) *GetSynonymRule
- func (r *GetSynonymRule) SetId(setid string) *GetSynonymRule
- type NewGetSynonymRule
- 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 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/master/get-synonym-rule.html
func (GetSynonymRule) Do ¶
func (r GetSynonymRule) Do(ctx 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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetSynonymRule) IsSuccess ¶
func (r GetSynonymRule) IsSuccess(ctx 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 ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetSynonymRule) RuleId ¶
func (r *GetSynonymRule) RuleId(ruleid string) *GetSynonymRule
RuleId The id of the synonym rule to retrieve API Name: ruleid
func (*GetSynonymRule) SetId ¶
func (r *GetSynonymRule) SetId(setid string) *GetSynonymRule
SetId The id of the synonym set to retrieve the synonym rule from API Name: setid
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"`
}
Source Files