reloadsearchanalyzers

package
v8.13.1 Latest Latest
Warning

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

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 13 Imported by: 3

Documentation

Overview

Reloads an index's search analyzers and their resources.

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 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 (*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) 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) 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) 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 added in v8.7.0

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

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

type Response added in v8.7.0

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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersResponse.ts#L22-L24

func NewResponse added in v8.7.0

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