Package co.elastic.clients.elasticsearch.searchable_snapshots

Class ClearCacheRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.searchable_snapshots.ClearCacheRequest

public class ClearCacheRequest
extends RequestBase

Clear the cache.

Clear indices and data streams from the shared cache for partially mounted indices.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<ClearCacheRequest,ClearCacheResponse,ErrorResponse>	_ENDPOINT	Endpoint "searchable_snapshots.clear_cache".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	A setting that does two separate checks on the index expression.
final List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both
final Boolean	ignoreUnavailable()	If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable.
final List<String>	index()	A comma-separated list of data streams, indices, and aliases to clear from the cache.
static ClearCacheRequest	of(Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)
ClearCacheRequest.Builder	rebuild()

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<ClearCacheRequest,ClearCacheResponse,ErrorResponse> _ENDPOINT

Endpoint "searchable_snapshots.clear_cache".

Method Details

of

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

allowNoIndices

@Nullable
public final Boolean allowNoIndices()

A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

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

If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

API name: ignore_unavailable

index

public final List<String> index()

A comma-separated list of data streams, indices, and aliases to clear from the cache. It supports wildcards (*).

API name: index

rebuild

public ClearCacheRequest.Builder rebuild()

Returns:

New ClearCacheRequest.Builder initialized with field values of this instance