Documentation ¶
Overview ¶
Delete a synonym rule. Delete a synonym rule from a synonym set.
Index ¶
- Variables
- type DeleteSynonymRule
- func (r DeleteSynonymRule) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteSynonymRule) ErrorTrace(errortrace bool) *DeleteSynonymRule
- func (r *DeleteSynonymRule) FilterPath(filterpaths ...string) *DeleteSynonymRule
- func (r *DeleteSynonymRule) Header(key, value string) *DeleteSynonymRule
- func (r *DeleteSynonymRule) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DeleteSynonymRule) Human(human bool) *DeleteSynonymRule
- func (r DeleteSynonymRule) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DeleteSynonymRule) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteSynonymRule) Pretty(pretty bool) *DeleteSynonymRule
- type NewDeleteSynonymRule
- 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 DeleteSynonymRule ¶
type DeleteSynonymRule struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteSynonymRule
Delete a synonym rule. Delete a synonym rule from 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) ErrorTrace ¶ added in v8.14.0
func (r *DeleteSynonymRule) ErrorTrace(errortrace bool) *DeleteSynonymRule
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*DeleteSynonymRule) FilterPath ¶ added in v8.14.0
func (r *DeleteSynonymRule) FilterPath(filterpaths ...string) *DeleteSynonymRule
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*DeleteSynonymRule) Human ¶ added in v8.14.0
func (r *DeleteSynonymRule) Human(human bool) *DeleteSynonymRule
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
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 ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteSynonymRule) Pretty ¶ added in v8.14.0
func (r *DeleteSynonymRule) Pretty(pretty bool) *DeleteSynonymRule
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
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