Package co.elastic.clients.elasticsearch.indices

Class ReloadSearchAnalyzersRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.ReloadSearchAnalyzersRequest

public class ReloadSearchAnalyzersRequest
extends RequestBase

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.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReloadSearchAnalyzersRequest.Builder	Builder for ReloadSearchAnalyzersRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<ReloadSearchAnalyzersRequest,ReloadSearchAnalyzersResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.reload_search_analyzers".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
final List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final List<String>	index()	Required - A comma-separated list of index names to reload analyzers for
static ReloadSearchAnalyzersRequest	of(Function<ReloadSearchAnalyzersRequest.Builder,ObjectBuilder<ReloadSearchAnalyzersRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<ReloadSearchAnalyzersRequest,ReloadSearchAnalyzersResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.reload_search_analyzers".

Method Details

of

public static ReloadSearchAnalyzersRequest of(Function<ReloadSearchAnalyzersRequest.Builder,ObjectBuilder<ReloadSearchAnalyzersRequest>> fn)

allowNoIndices

@Nullable
public final Boolean 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

expandWildcards

public final List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

public final List<String> index()

Required - A comma-separated list of index names to reload analyzers for

API name: index