Package co.elastic.clients.elasticsearch.indices

Class ClearCacheRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ClearCacheRequest.Builder>
co.elastic.clients.elasticsearch.indices.ClearCacheRequest.Builder
All Implemented Interfaces:
WithJson<ClearCacheRequest.Builder>, ObjectBuilder<ClearCacheRequest>
Enclosing class:
ClearCacheRequest
public static class ClearCacheRequest.Builder extends RequestBase.AbstractBuilder<ClearCacheRequest.Builder> implements ObjectBuilder<ClearCacheRequest>
Builder for ClearCacheRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final ClearCacheRequest.Builder allowNoIndices(@Nullable Boolean value)
      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 ClearCacheRequest.Builder expandWildcards(List<ExpandWildcard> list)
      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.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final ClearCacheRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      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.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • fielddata

      public final ClearCacheRequest.Builder fielddata(@Nullable Boolean value)
      If true, clears the fields cache. Use the fields parameter to clear the cache of specific fields only.

      API name: fielddata

    • fields

      public final ClearCacheRequest.Builder fields(List<String> list)
      Comma-separated list of field names used to limit the fielddata parameter.

      API name: fields

      Adds all elements of list to fields.

    • fields

      public final ClearCacheRequest.Builder fields(String value, String... values)
      Comma-separated list of field names used to limit the fielddata parameter.

      API name: fields

      Adds one or more values to fields.

    • ignoreUnavailable

      public final ClearCacheRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      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 ClearCacheRequest.Builder index(List<String> list)
      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

      Adds all elements of list to index.

    • index

      public final ClearCacheRequest.Builder index(String value, String... values)
      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

      Adds one or more values to index.

    • query

      public final ClearCacheRequest.Builder query(@Nullable Boolean value)
      If true, clears the query cache.

      API name: query

    • request

      public final ClearCacheRequest.Builder request(@Nullable Boolean value)
      If true, clears the request cache.

      API name: request

    • self

      protected ClearCacheRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<ClearCacheRequest.Builder>

    • build

      public ClearCacheRequest build()
      Builds a ClearCacheRequest.
      Specified by:
      build in interface ObjectBuilder<ClearCacheRequest>
      Throws:
      NullPointerException - if some of the required fields are null.