Class 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)
      Whether to expand wildcard expression to concrete indices that are open, closed or both

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final ClearCacheRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      Whether to expand wildcard expression to concrete indices that are open, closed or both

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • 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)
      A comma-separated list of data streams, indices, and aliases to clear from the cache. It supports wildcards (*).

      API name: index

      Adds all elements of list to index.

    • index

      public final ClearCacheRequest.Builder index(String value, String... values)
      A comma-separated list of data streams, indices, and aliases to clear from the cache. It supports wildcards (*).

      API name: index

      Adds one or more values to index.

    • self

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

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