Package org.opensearch.client.opensearch.indices

Class ClearCacheRequest.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ClearCacheRequest.Builder>
org.opensearch.client.opensearch.indices.ClearCacheRequest.Builder
All Implemented Interfaces:
CopyableBuilder<ClearCacheRequest.Builder,ClearCacheRequest>, MutableBuilder<ClearCacheRequest.Builder,ClearCacheRequest>, ObjectBuilder<ClearCacheRequest>
Enclosing class:
ClearCacheRequest
public static class ClearCacheRequest.Builder extends RequestBase.AbstractBuilder<ClearCacheRequest.Builder> implements CopyableBuilder<ClearCacheRequest.Builder,ClearCacheRequest>
Builder for ClearCacheRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public ClearCacheRequest.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<ClearCacheRequest.Builder,ClearCacheRequest>
      Returns:
      a new builder instance.

    • self

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

    • allowNoIndices

      @Nonnull public final ClearCacheRequest.Builder allowNoIndices(@Nullable Boolean value)
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

      API name: allow_no_indices

    • expandWildcards

      @Nonnull 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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      @Nonnull 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. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • fielddata

      @Nonnull 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

      @Nonnull 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

      @Nonnull 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.

    • file

      @Nonnull public final ClearCacheRequest.Builder file(@Nullable Boolean value)
      If true, clears the unused entries from the file cache on nodes with the Search role.

      API name: file

    • ignoreUnavailable

      @Nonnull public final ClearCacheRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a missing or closed index.

      API name: ignore_unavailable

    • index

      @Nonnull public final ClearCacheRequest.Builder index(List<String> list)
      Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

      API name: index

      Adds all elements of list to index.

    • index

      @Nonnull public final ClearCacheRequest.Builder index(String value, String... values)
      Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

      API name: index

      Adds one or more values to index.

    • query

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

      API name: query

    • request

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

      API name: request

    • build

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