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
Clear the cache. Clear the cache of one or more indices. For data streams, the API clears the caches of the stream's backing indices.

By default, the clear cache API clears all caches. To clear only specific caches, use the fielddata, query, or request parameters. To clear the cache only of specific fields, use the fields parameter.

See Also:

  • Field Details

  • 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