deletesynonymrule

Documentation

Overview

Deletes a synonym rule in a synonym set

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteSynonymRule

Deletes a synonym rule in a synonym set

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

func (DeleteSynonymRule) Do

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

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

func (*DeleteSynonymRule) Header

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

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

func (*DeleteSynonymRule) HttpRequest

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

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

func (DeleteSynonymRule) IsSuccess

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

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

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

type NewDeleteSynonymRule

type NewDeleteSynonymRule func(setid, ruleid string) *DeleteSynonymRule

NewDeleteSynonymRule type alias for index.

func NewDeleteSynonymRuleFunc

func NewDeleteSynonymRuleFunc(tp elastictransport.Interface) NewDeleteSynonymRule

NewDeleteSynonymRuleFunc returns a new instance of DeleteSynonymRule 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 {

	// 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 deletesynonymrule

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response