Package org.opensearch.client.opensearch.indices

Class FlushRequest

  • public class FlushRequest
extends RequestBase
    Performs the flush operation on one or more indices.

    • Method Detail

      • allowNoIndices

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

        API name: allow_no_indices

      • expandWildcards

        public final java.util.List<ExpandWildcard> expandWildcards()
        Whether to expand wildcard expression to concrete indices that are open, closed or both.

        API name: expand_wildcards

      • force

        @Nullable
public final java.lang.Boolean force()
        Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)

        API name: force

      • ignoreUnavailable

        @Nullable
public final java.lang.Boolean ignoreUnavailable()
        Whether specified concrete indices should be ignored when unavailable (missing or closed)

        API name: ignore_unavailable

      • index

        public final java.util.List<java.lang.String> index()
        A comma-separated list of index names; use _all or empty string for all indices

        API name: index

      • waitIfOngoing

        @Nullable
public final java.lang.Boolean waitIfOngoing()
        If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running.

        API name: wait_if_ongoing