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)
      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 FlushRequest.Builder expandWildcards(List<ExpandWildcard> list)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

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

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • force

      public final FlushRequest.Builder force(@Nullable 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 final FlushRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • index

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

      API name: index

      Adds all elements of list to index.

    • index

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

      API name: index

      Adds one or more values to index.

    • waitIfOngoing

      public final FlushRequest.Builder waitIfOngoing(@Nullable 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

    • 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.