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.

allowFailureIndices - , allow failure indices in the response, true by default

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 allowFailureIndices, 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 Classes

Modifier and Type	Class	Description
static class	IndicesOptions.GatekeeperOptions.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final IndicesOptions.GatekeeperOptions	DEFAULT
static final String	IGNORE_THROTTLED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GatekeeperOptions(boolean allowAliasToMultipleIndices, boolean allowClosedIndices, boolean allowFailureIndices, boolean ignoreThrottled)	Creates an instance of a GatekeeperOptions record class.

Method Summary

Modifier and Type	Method	Description
boolean	allowAliasToMultipleIndices()	Returns the value of the allowAliasToMultipleIndices record component.
boolean	allowClosedIndices()	Returns the value of the allowClosedIndices record component.
boolean	allowFailureIndices()	Returns the value of the allowFailureIndices record component.
static IndicesOptions.GatekeeperOptions.Builder	builder()
static IndicesOptions.GatekeeperOptions.Builder	builder(IndicesOptions.GatekeeperOptions gatekeeperOptions)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	ignoreThrottled()	Deprecated.
static IndicesOptions.GatekeeperOptions	parseParameter(Object ignoreThrottled, IndicesOptions.GatekeeperOptions defaultOptions)
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

IGNORE_THROTTLED

public static final String IGNORE_THROTTLED

See Also:

• Constant Field Values

DEFAULT

public static final IndicesOptions.GatekeeperOptions DEFAULT

Constructor Details

GatekeeperOptions

public GatekeeperOptions(boolean allowAliasToMultipleIndices,
 boolean allowClosedIndices,
 boolean allowFailureIndices,
 @Deprecated
 boolean ignoreThrottled)

Creates an instance of a GatekeeperOptions record class.

Parameters:

allowAliasToMultipleIndices - the value for the allowAliasToMultipleIndices record component

allowClosedIndices - the value for the allowClosedIndices record component

allowFailureIndices - the value for the allowFailureIndices record component

ignoreThrottled - the value for the ignoreThrottled record 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:

toXContent in interface ToXContent

Throws:

IOException

builder

public static IndicesOptions.GatekeeperOptions.Builder builder()

builder

public static IndicesOptions.GatekeeperOptions.Builder builder(IndicesOptions.GatekeeperOptions gatekeeperOptions)

toString

public final String 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.

Specified by:

toString in class Record

Returns:

a string representation of this object

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.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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 '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

allowAliasToMultipleIndices

public boolean allowAliasToMultipleIndices()

Returns the value of the allowAliasToMultipleIndices record component.

Returns:

the value of the allowAliasToMultipleIndices record component

allowClosedIndices

public boolean allowClosedIndices()

Returns the value of the allowClosedIndices record component.

Returns:

the value of the allowClosedIndices record component

allowFailureIndices

public boolean allowFailureIndices()

Returns the value of the allowFailureIndices record component.

Returns:

the value of the allowFailureIndices record component

ignoreThrottled

@Deprecated
public boolean ignoreThrottled()

Deprecated.

Returns the value of the ignoreThrottled record component.

Returns:

the value of the ignoreThrottled record component