getsynonymssets

package
v8.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 27, 2023 License: Apache-2.0 Imports: 13 Imported by: 2

Documentation

Overview

Retrieves a summary of all defined synonym sets

Index

Constants

This section is empty.

Variables

View Source
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 GetSynonymsSets

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

func (GetSynonymsSets) Do

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

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

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

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

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

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/5fea44e006349579bf3561a82e997002e5716117/specification/synonyms/get_synonyms_sets/SynonymsSetsGetResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL