Record Class IndicesOptions.GatekeeperOptions

java.lang.Object
java.lang.Record
org.elasticsearch.action.support.IndicesOptions.GatekeeperOptions
Record Components:
allowAliasToMultipleIndices - , allow aliases to multiple indices, true by default.
allowClosedIndices - , allow closed indices, true by default.
allowSelectors - , allow selectors within index expressions, true by default.
includeFailureIndices - , when true includes the failure indices when a data stream or a data stream alias is encountered and selectors are not allowed.
ignoreThrottled - , filters out throttled (aka frozen indices), defaults to true. This is deprecated and the only one that only filters and never throws an error.
All Implemented Interfaces:
ToXContent, ToXContentFragment
Enclosing class:
IndicesOptions

public static record IndicesOptions.GatekeeperOptions(boolean allowAliasToMultipleIndices, boolean allowClosedIndices, boolean allowSelectors, boolean includeFailureIndices, boolean ignoreThrottled) extends Record implements ToXContentFragment
The "gatekeeper" options apply on all indices that have been selected by the other Options. It contains two type of flags: - The "allow*" flags, which purpose is to enable actions to define certain conditions that need to apply on the concrete indices they accept. For example, single-index actions will set allowAliasToMultipleIndices to false, while search will not accept a closed index etc. These options are not configurable by the end-user. - The ignoreThrottled flag, which is a deprecated flag that will filter out frozen indices.