deletesynonym

Documentation

Overview

Deletes a synonym set

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteSynonym

Deletes a synonym set

https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-synonyms-set.html

func (DeleteSynonym) Do

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

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

func (*DeleteSynonym) Header

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

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

func (*DeleteSynonym) HttpRequest

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

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

func (DeleteSynonym) IsSuccess

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

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

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

type NewDeleteSynonym

type NewDeleteSynonym func(id string) *DeleteSynonym

NewDeleteSynonym type alias for index.

func NewDeleteSynonymFunc

func NewDeleteSynonymFunc(tp elastictransport.Interface) NewDeleteSynonym

NewDeleteSynonymFunc returns a new instance of DeleteSynonym 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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package deletesynonym

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response