Package co.elastic.clients.elasticsearch.indices

Class FlushRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final FlushRequest.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 indices. This behavior applies even if the request targets other open indices.

      API name: allow_no_indices

    • expandWildcards

      public final FlushRequest.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

      public final FlushRequest.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.

    • force

      public final FlushRequest.Builder force(@Nullable Boolean value)
      If true, the request forces a flush even if there are no changes to commit to the index.

      API name: force

    • ignoreUnavailable

      public final FlushRequest.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

      public final FlushRequest.Builder index(List<String> list)
      Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (*). To flush 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 FlushRequest.Builder index(String value, String... values)
      Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (*). To flush all data streams and indices, omit this parameter or use * or _all.

      API name: index

      Adds one or more values to index.

    • waitIfOngoing

      public final FlushRequest.Builder waitIfOngoing(@Nullable Boolean value)
      If true, the flush operation blocks until execution when another flush operation is running. If false, Elasticsearch returns an error if you request a flush when another flush operation is running.

      API name: wait_if_ongoing

    • self

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

    • build

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