Package org.opensearch.client.opensearch.indices

Class ForcemergeRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.ForcemergeRequest
All Implemented Interfaces:
ToCopyableBuilder<ForcemergeRequest.Builder,ForcemergeRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class ForcemergeRequest extends RequestBase implements ToCopyableBuilder<ForcemergeRequest.Builder,ForcemergeRequest>
Performs the force merge operation on one or more indexes.

  • Field Details

  • Method Details

    • of

      public static ForcemergeRequest of(Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified)

      API name: allow_no_indices

    • expandWildcards

      @Nonnull public final List<ExpandWildcard> expandWildcards()
      Whether to expand wildcard expression to concrete indexes that are open, closed or both.

      API name: expand_wildcards

    • flush

      @Nullable public final Boolean flush()
      Specify whether the index should be flushed after performing the operation.

      API name: flush

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      Whether specified concrete indexes should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • index

      @Nonnull public final List<String> index()
      A comma-separated list of index names; use _all or empty string to perform the operation on all indexes

      API name: index

    • maxNumSegments

      @Nullable public final Long maxNumSegments()
      The number of larger segments into which smaller segments are merged. Set this parameter to 1 to merge all segments into one segment. The default behavior is to perform the merge as necessary.

      API name: max_num_segments

    • onlyExpungeDeletes

      @Nullable public final Boolean onlyExpungeDeletes()
      Specify whether the operation should only expunge deleted documents

      API name: only_expunge_deletes

    • primaryOnly

      @Nullable public final Boolean primaryOnly()
      Specify whether the operation should only perform on primary shards. Defaults to false.

      API name: primary_only

    • waitForCompletion

      @Nullable public final Boolean waitForCompletion()
      Should the request wait until the force merge is completed.

      API name: wait_for_completion

    • toBuilder

      @Nonnull public ForcemergeRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ForcemergeRequest.Builder,ForcemergeRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static ForcemergeRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object