reloadsearchanalyzers

Documentation

Overview

Reload search analyzers. Reload an index's search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream's backing indices.

IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.

You can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer. To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers.

NOTE: This API does not perform a reload for each shard of an index. Instead, it performs a reload for each node containing index shards. As a result, the total shard count returned by the API can differ from the number of index shards. Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.

Index

• Variables
• type NewReloadSearchAnalyzers
  • func NewReloadSearchAnalyzersFunc(tp elastictransport.Interface) NewReloadSearchAnalyzers
• type ReloadSearchAnalyzers
  • func New(tp elastictransport.Interface) *ReloadSearchAnalyzers
  • func (r *ReloadSearchAnalyzers) AllowNoIndices(allownoindices bool) *ReloadSearchAnalyzers
  • func (r ReloadSearchAnalyzers) Do(providedCtx context.Context) (*Response, error)
  • func (r *ReloadSearchAnalyzers) ErrorTrace(errortrace bool) *ReloadSearchAnalyzers
  • func (r *ReloadSearchAnalyzers) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ReloadSearchAnalyzers
  • func (r *ReloadSearchAnalyzers) FilterPath(filterpaths ...string) *ReloadSearchAnalyzers
  • func (r *ReloadSearchAnalyzers) Header(key, value string) *ReloadSearchAnalyzers
  • func (r *ReloadSearchAnalyzers) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ReloadSearchAnalyzers) Human(human bool) *ReloadSearchAnalyzers
  • func (r *ReloadSearchAnalyzers) IgnoreUnavailable(ignoreunavailable bool) *ReloadSearchAnalyzers
  • func (r ReloadSearchAnalyzers) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ReloadSearchAnalyzers) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ReloadSearchAnalyzers) Pretty(pretty bool) *ReloadSearchAnalyzers
• 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 NewReloadSearchAnalyzers

type NewReloadSearchAnalyzers func(index string) *ReloadSearchAnalyzers

NewReloadSearchAnalyzers type alias for index.

func NewReloadSearchAnalyzersFunc

func NewReloadSearchAnalyzersFunc(tp elastictransport.Interface) NewReloadSearchAnalyzers

NewReloadSearchAnalyzersFunc returns a new instance of ReloadSearchAnalyzers with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type ReloadSearchAnalyzers

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

func New

func New(tp elastictransport.Interface) *ReloadSearchAnalyzers

Reload search analyzers. Reload an index's search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream's backing indices.

IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.

You can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer. To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers.

NOTE: This API does not perform a reload for each shard of an index. Instead, it performs a reload for each node containing index shards. As a result, the total shard count returned by the API can differ from the number of index shards. Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-reload-analyzers.html

func (*ReloadSearchAnalyzers) AllowNoIndices

func (r *ReloadSearchAnalyzers) AllowNoIndices(allownoindices bool) *ReloadSearchAnalyzers

AllowNoIndices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) API name: allow_no_indices

func (ReloadSearchAnalyzers) Do

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

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

func (*ReloadSearchAnalyzers) ErrorTrace

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

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

func (*ReloadSearchAnalyzers) ExpandWildcards

func (r *ReloadSearchAnalyzers) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ReloadSearchAnalyzers

ExpandWildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. API name: expand_wildcards

func (*ReloadSearchAnalyzers) FilterPath

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

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

func (*ReloadSearchAnalyzers) Header

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

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

func (*ReloadSearchAnalyzers) HttpRequest

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

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

func (*ReloadSearchAnalyzers) Human

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

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 (*ReloadSearchAnalyzers) IgnoreUnavailable

func (r *ReloadSearchAnalyzers) IgnoreUnavailable(ignoreunavailable bool) *ReloadSearchAnalyzers

IgnoreUnavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) API name: ignore_unavailable

func (ReloadSearchAnalyzers) IsSuccess

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

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

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

func (*ReloadSearchAnalyzers) Pretty

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

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

type Response

type Response struct {
	ReloadDetails []types.ReloadDetails `json:"reload_details"`
	Shards_       types.ShardStatistics `json:"_shards"`
}

Response holds the response body struct for the package reloadsearchanalyzers

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response