Module org.elasticsearch.server
Package org.elasticsearch.action.support
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.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IndicesOptions.GatekeeperOptionsstatic final StringFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionGatekeeperOptions(boolean allowAliasToMultipleIndices, boolean allowClosedIndices, boolean allowSelectors, boolean includeFailureIndices, boolean ignoreThrottled) Creates an instance of aGatekeeperOptionsrecord class. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns the value of theallowAliasToMultipleIndicesrecord component.booleanReturns the value of theallowClosedIndicesrecord component.booleanReturns the value of theallowSelectorsrecord component.builder()builder(IndicesOptions.GatekeeperOptions gatekeeperOptions) final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.booleanDeprecated.booleanReturns the value of theincludeFailureIndicesrecord component.parseParameter(Object ignoreThrottled, IndicesOptions.GatekeeperOptions defaultOptions) final StringtoString()Returns a string representation of this record class.toXContent(XContentBuilder builder, ToXContent.Params params) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
IGNORE_THROTTLED
- See Also:
-
DEFAULT
-
-
Constructor Details
-
GatekeeperOptions
public GatekeeperOptions(boolean allowAliasToMultipleIndices, boolean allowClosedIndices, boolean allowSelectors, boolean includeFailureIndices, @Deprecated boolean ignoreThrottled) Creates an instance of aGatekeeperOptionsrecord class.- Parameters:
allowAliasToMultipleIndices- the value for theallowAliasToMultipleIndicesrecord componentallowClosedIndices- the value for theallowClosedIndicesrecord componentallowSelectors- the value for theallowSelectorsrecord componentincludeFailureIndices- the value for theincludeFailureIndicesrecord componentignoreThrottled- the value for theignoreThrottledrecord component
-
-
Method Details
-
parseParameter
public static IndicesOptions.GatekeeperOptions parseParameter(Object ignoreThrottled, IndicesOptions.GatekeeperOptions defaultOptions) -
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
builder
-
builder
public static IndicesOptions.GatekeeperOptions.Builder builder(IndicesOptions.GatekeeperOptions gatekeeperOptions) -
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='. -
allowAliasToMultipleIndices
public boolean allowAliasToMultipleIndices()Returns the value of theallowAliasToMultipleIndicesrecord component.- Returns:
- the value of the
allowAliasToMultipleIndicesrecord component
-
allowClosedIndices
public boolean allowClosedIndices()Returns the value of theallowClosedIndicesrecord component.- Returns:
- the value of the
allowClosedIndicesrecord component
-
allowSelectors
public boolean allowSelectors()Returns the value of theallowSelectorsrecord component.- Returns:
- the value of the
allowSelectorsrecord component
-
includeFailureIndices
public boolean includeFailureIndices()Returns the value of theincludeFailureIndicesrecord component.- Returns:
- the value of the
includeFailureIndicesrecord component
-
ignoreThrottled
Deprecated.Returns the value of theignoreThrottledrecord component.- Returns:
- the value of the
ignoreThrottledrecord component
-