Package co.elastic.clients.elasticsearch.indices

Class FlushRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.indices.FlushRequest.Builder
All Implemented Interfaces:
ObjectBuilder<FlushRequest>
Enclosing class:
FlushRequest
public static class FlushRequest.Builder
extends java.lang.Object
implements ObjectBuilder<FlushRequest>
Builder for FlushRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • index

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

      API name: index

    • index

      public FlushRequest.Builder index​(java.lang.String... value)
      A comma-separated list of index names; use _all or empty string for all indices

      API name: index

    • addIndex

      public FlushRequest.Builder addIndex​(java.lang.String value)
      Add a value to index(List), creating the list if needed.

    • allowNoIndices

      public FlushRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      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 FlushRequest.Builder expandWildcards​(@Nullable java.util.List<ExpandWildcardOptions> value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • expandWildcards

      public FlushRequest.Builder expandWildcards​(ExpandWildcardOptions... value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • addExpandWildcards

      public FlushRequest.Builder addExpandWildcards​(ExpandWildcardOptions value)
      Add a value to expandWildcards(List), creating the list if needed.

    • force

      public FlushRequest.Builder force​(@Nullable java.lang.Boolean value)
      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

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

      API name: ignore_unavailable

    • waitIfOngoing

      public FlushRequest.Builder waitIfOngoing​(@Nullable java.lang.Boolean value)
      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

    • build

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