getsynonymssets

Documentation

Overview

Get all synonym sets. Get a summary of all defined synonym sets.

Index

• Variables
• type GetSynonymsSets
  • func New(tp elastictransport.Interface) *GetSynonymsSets
  • func (r GetSynonymsSets) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetSynonymsSets) ErrorTrace(errortrace bool) *GetSynonymsSets
  • func (r *GetSynonymsSets) FilterPath(filterpaths ...string) *GetSynonymsSets
  • func (r *GetSynonymsSets) From(from int) *GetSynonymsSets
  • func (r *GetSynonymsSets) Header(key, value string) *GetSynonymsSets
  • func (r *GetSynonymsSets) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetSynonymsSets) Human(human bool) *GetSynonymsSets
  • func (r GetSynonymsSets) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetSynonymsSets) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetSynonymsSets) Pretty(pretty bool) *GetSynonymsSets
  • func (r *GetSynonymsSets) Size(size int) *GetSynonymsSets
• type NewGetSynonymsSets
  • func NewGetSynonymsSetsFunc(tp elastictransport.Interface) NewGetSynonymsSets
• 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 GetSynonymsSets

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

func New

func New(tp elastictransport.Interface) *GetSynonymsSets

Get all synonym sets. Get a summary of all defined synonym sets.

https://www.elastic.co/guide/en/elasticsearch/reference/current/list-synonyms-sets.html

func (GetSynonymsSets) Do

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

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

func (*GetSynonymsSets) ErrorTrace

func (r *GetSynonymsSets) ErrorTrace(errortrace bool) *GetSynonymsSets

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*GetSynonymsSets) FilterPath

func (r *GetSynonymsSets) FilterPath(filterpaths ...string) *GetSynonymsSets

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*GetSynonymsSets) From

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

From Starting offset API name: from

func (*GetSynonymsSets) Header

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

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

func (*GetSynonymsSets) HttpRequest

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

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

func (*GetSynonymsSets) Human

func (r *GetSynonymsSets) Human(human bool) *GetSynonymsSets

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 (GetSynonymsSets) IsSuccess

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

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

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

func (*GetSynonymsSets) Pretty

func (r *GetSynonymsSets) Pretty(pretty bool) *GetSynonymsSets

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*GetSynonymsSets) Size

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

Size specifies a max number of results to get API name: size

type NewGetSynonymsSets

type NewGetSynonymsSets func() *GetSynonymsSets

NewGetSynonymsSets type alias for index.

func NewGetSynonymsSetsFunc

func NewGetSynonymsSetsFunc(tp elastictransport.Interface) NewGetSynonymsSets

NewGetSynonymsSetsFunc returns a new instance of GetSynonymsSets 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"`
	Results []types.SynonymsSetItem `json:"results"`
}

Response holds the response body struct for the package getsynonymssets

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/synonyms/get_synonyms_sets/SynonymsSetsGetResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response