Package org.opensearch.client.opensearch.indices

Class FlushRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public FlushRequest.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<FlushRequest.Builder,FlushRequest>
      Returns:
      a new builder instance.

    • self

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

    • allowNoIndices

      @Nonnull 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 indexes. This behavior applies even if the request targets other open indexes.

      API name: allow_no_indices

    • expandWildcards

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

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

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

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

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

      API name: index

      Adds one or more values to index.

    • waitIfOngoing

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

      API name: wait_if_ongoing

    • build

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