Package co.elastic.clients.elasticsearch.indices

Class ClearCacheRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.ClearCacheRequest

public class ClearCacheRequest
extends RequestBase

Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing 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 "indices.clear_cache".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoIndices()	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.
final List<ExpandWildcard>	expandWildcards()	Type of index that wildcard patterns can match.
final Boolean	fielddata()	If true, clears the fields cache.
final List<String>	fields()	Comma-separated list of field names used to limit the fielddata parameter.
final Boolean	ignoreUnavailable()	If false, the request returns an error if it targets a missing or closed index.
final List<String>	index()	Comma-separated list of data streams, indices, and aliases used to limit the request.
static ClearCacheRequest	of(Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)
final Boolean	query()	If true, clears the query cache.
final Boolean	request()	If true, clears the request cache.

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 "indices.clear_cache".

Method Details

of

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

allowNoIndices

@Nullable
public final Boolean allowNoIndices()

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

API name: allow_no_indices

expandWildcards

public final List<ExpandWildcard> expandWildcards()

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

API name: expand_wildcards

fielddata

@Nullable
public final Boolean fielddata()

If true, clears the fields cache. Use the fields parameter to clear the cache of specific fields only.

API name: fielddata

fields

public final List<String> fields()

Comma-separated list of field names used to limit the fielddata parameter.

API name: fields

ignoreUnavailable

@Nullable
public final Boolean ignoreUnavailable()

If false, the request returns an error if it targets a missing or closed index.

API name: ignore_unavailable

index

public final List<String> index()

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

API name: index

query

@Nullable
public final Boolean query()

If true, clears the query cache.

API name: query

request

@Nullable
public final Boolean request()

If true, clears the request cache.

API name: request