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

Class IndicesOptions.GatekeeperOptions.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowAliasToMultipleIndices

      public IndicesOptions.GatekeeperOptions.Builder allowAliasToMultipleIndices(boolean allowAliasToMultipleIndices)
      Aliases that resolve to multiple indices are accepted when true, otherwise the resolution will throw an error. Defaults to true.

    • allowClosedIndices

      public IndicesOptions.GatekeeperOptions.Builder allowClosedIndices(boolean allowClosedIndices)
      Closed indices are accepted when true, otherwise the resolution will throw an error. Defaults to true.

    • allowSelectors

      public IndicesOptions.GatekeeperOptions.Builder allowSelectors(boolean allowSelectors)
      Selectors are allowed within index expressions when true, otherwise the resolution will treat their presence as a syntax error when resolving index expressions. Defaults to true.

    • includeFailureIndices

      public IndicesOptions.GatekeeperOptions.Builder includeFailureIndices(boolean includeFailureIndices)
      When the selectors are not allowed, this flag determines if we will include the failure store indices in the resolution or not. Defaults to false.

    • ignoreThrottled

      public IndicesOptions.GatekeeperOptions.Builder ignoreThrottled(boolean ignoreThrottled)
      Throttled indices will not be included in the result. Defaults to false.

    • build

      public IndicesOptions.GatekeeperOptions build()