Package org.opensearch.client.opensearch.indices

Class ClearCacheRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.ClearCacheRequest

public class ClearCacheRequest
extends RequestBase

Clears all or specific caches for one or more indices.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<ClearCacheRequest,ClearCacheResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.clear_cache".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
java.util.List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
java.lang.Boolean	fielddata()	Clear field data
java.util.List<java.lang.String>	fields()	A comma-separated list of fields to clear when using the fielddata parameter (default: all)
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.util.List<java.lang.String>	index()	A comma-separated list of index name to limit the operation
static ClearCacheRequest	of(java.util.function.Function<ClearCacheRequest.Builder,ObjectBuilder<ClearCacheRequest>> fn)
java.lang.Boolean	query()	Clear query caches
java.lang.Boolean	request()	Clear request cache

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<ClearCacheRequest,ClearCacheResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.clear_cache".

Method Detail

of

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

allowNoIndices

@Nullable
public final java.lang.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 java.util.List<ExpandWildcard> expandWildcards()

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

API name: expand_wildcards

fielddata

@Nullable
public final java.lang.Boolean fielddata()

Clear field data

API name: fielddata

fields

public final java.util.List<java.lang.String> fields()

A comma-separated list of fields to clear when using the fielddata parameter (default: all)

API name: fields

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

index

public final java.util.List<java.lang.String> index()

A comma-separated list of index name to limit the operation

API name: index

query

@Nullable
public final java.lang.Boolean query()

Clear query caches

API name: query

request

@Nullable
public final java.lang.Boolean request()

Clear request cache

API name: request