Module org.elasticsearch.server
Package org.elasticsearch.action.support

Class IndicesOptions.WildcardOptions.Builder

java.lang.Object
org.elasticsearch.action.support.IndicesOptions.WildcardOptions.Builder
Enclosing class:
IndicesOptions.WildcardOptions
public static class IndicesOptions.WildcardOptions.Builder extends Object

  • Method Details

    • matchOpen

      public IndicesOptions.WildcardOptions.Builder matchOpen(boolean matchOpen)
      Open indices will be matched. Defaults to true.

    • matchClosed

      public IndicesOptions.WildcardOptions.Builder matchClosed(boolean matchClosed)
      Closed indices will be matched. Default to false.

    • includeHidden

      public IndicesOptions.WildcardOptions.Builder includeHidden(boolean includeHidden)
      Hidden indices will be included from the result. Defaults to false.

    • allowEmptyExpressions

      public IndicesOptions.WildcardOptions.Builder allowEmptyExpressions(boolean allowEmptyExpressions)
      If true, when any of the expressions does not match any indices, we consider the result of this expression empty; if all the expressions are empty then we have a successful but empty response. If false, we throw an error immediately, so even if other expressions would result into indices the response will contain only the error. Defaults to true.

    • matchNone

      public IndicesOptions.WildcardOptions.Builder matchNone()
      Disables expanding wildcards.

    • all

      public IndicesOptions.WildcardOptions.Builder all()
      Maximises the resolution of indices, we will match open, closed and hidden targets.

    • expandStates

      public IndicesOptions.WildcardOptions.Builder expandStates(String[] expandStates)
      Parses the list of wildcard states to expand as provided by the user. Logs a warning when the option 'none' is used along with other options because the position in the list changes the outcome.

    • build

      public IndicesOptions.WildcardOptions build()