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 Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndicesOptions.GatekeeperOptions.Builder	allowAliasToMultipleIndices(boolean allowAliasToMultipleIndices)	Aliases that resolve to multiple indices are accepted when true, otherwise the resolution will throw an error.
IndicesOptions.GatekeeperOptions.Builder	allowClosedIndices(boolean allowClosedIndices)	Closed indices are accepted when true, otherwise the resolution will throw an error.
IndicesOptions.GatekeeperOptions.Builder	allowFailureIndices(boolean allowFailureIndices)	Failure indices are accepted when true, otherwise the resolution will throw an error.
IndicesOptions.GatekeeperOptions	build()
IndicesOptions.GatekeeperOptions.Builder	ignoreThrottled(boolean ignoreThrottled)	Throttled indices will not be included in the result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

allowFailureIndices

public IndicesOptions.GatekeeperOptions.Builder allowFailureIndices(boolean allowFailureIndices)

Failure indices are accepted when true, otherwise the resolution will throw an error. Defaults to true.

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()