Module org.elasticsearch.server
Package org.elasticsearch.action.support
Record Class IndicesOptions
java.lang.Object
java.lang.Record
org.elasticsearch.action.support.IndicesOptions
- Record Components:
concreteTargetOptions
- , applies only to concrete targets and defines how the response will handle when a concrete target does not exist.wildcardOptions
- , applies only to wildcard expressions and defines how the wildcards will be expanded and if it will be acceptable to have expressions that results to no indices.generalOptions
- , applies to all the resolved indices and defines if throttled will be included and if certain type of aliases or indices are allowed, or they will throw an error.
- All Implemented Interfaces:
ToXContent
,ToXContentFragment
public record IndicesOptions(IndicesOptions.ConcreteTargetOptions concreteTargetOptions, IndicesOptions.WildcardOptions wildcardOptions, IndicesOptions.GeneralOptions generalOptions)
extends Record
implements ToXContentFragment
Contains all the multi-target syntax options. These options are split into groups depending on what aspect of the syntax they
influence.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static final record
Controls the way the target indices will be handled.static final record
These options apply on all indices that have been selected by the other Options.static final record
Controls the way the wildcard expressions will be resolved.Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IndicesOptions
static final IndicesOptions
static final IndicesOptions
static final IndicesOptions
static final IndicesOptions
static final IndicesOptions
static final IndicesOptions
static final IndicesOptions
static final IndicesOptions
static final IndicesOptions
static final IndicesOptions
static final IndicesOptions
static final IndicesOptions
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS
-
Constructor Summary
ConstructorsConstructorDescriptionIndicesOptions
(IndicesOptions.ConcreteTargetOptions concreteTargetOptions, IndicesOptions.WildcardOptions wildcardOptions, IndicesOptions.GeneralOptions generalOptions) Creates an instance of aIndicesOptions
record class. -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
static IndicesOptions.Builder
builder()
static IndicesOptions.Builder
builder
(IndicesOptions indicesOptions) Returns the value of theconcreteTargetOptions
record component.final boolean
Indicates whether some other object is "equal to" this one.boolean
boolean
boolean
boolean
boolean
static IndicesOptions
fromMap
(Map<String, Object> map, IndicesOptions defaultSettings) static IndicesOptions
fromOptions
(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices) static IndicesOptions
fromOptions
(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, boolean expandToHiddenIndices) static IndicesOptions
fromOptions
(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, boolean allowAliasesToMultipleIndices, boolean forbidClosedIndices, boolean ignoreAliases, boolean ignoreThrottled) static IndicesOptions
fromOptions
(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, boolean expandToHiddenIndices, boolean allowAliasesToMultipleIndices, boolean forbidClosedIndices, boolean ignoreAliases, boolean ignoreThrottled) static IndicesOptions
fromOptions
(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, IndicesOptions defaultOptions) static IndicesOptions
fromParameters
(Object wildcardsString, Object ignoreUnavailableString, Object allowNoIndicesString, Object ignoreThrottled, IndicesOptions defaultSettings) static IndicesOptions
fromRequest
(RestRequest request, IndicesOptions defaultSettings) static IndicesOptions
fromXContent
(XContentParser parser) static IndicesOptions
fromXContent
(XContentParser parser, IndicesOptions defaults) Returns the value of thegeneralOptions
record component.final int
hashCode()
Returns a hash code value for this object.boolean
boolean
boolean
static boolean
isIndicesOptions
(String name) Returns true if the name represents a valid name for one of the indices option false otherwisestatic IndicesOptions
static IndicesOptions
static IndicesOptions
static IndicesOptions
static IndicesOptions
static IndicesOptions
static IndicesOptions
static IndicesOptions
static IndicesOptions
static IndicesOptions
static IndicesOptions
static IndicesOptions
toString()
Returns a string representation of this record class.toXContent
(XContentBuilder builder, ToXContent.Params params) Returns the value of thewildcardOptions
record component.void
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
-
DEFAULT
-
STRICT_EXPAND_OPEN
-
LENIENT_EXPAND_OPEN
-
LENIENT_EXPAND_OPEN_HIDDEN
-
LENIENT_EXPAND_OPEN_CLOSED
-
LENIENT_EXPAND_OPEN_CLOSED_HIDDEN
-
STRICT_EXPAND_OPEN_CLOSED
-
STRICT_EXPAND_OPEN_CLOSED_HIDDEN
-
STRICT_EXPAND_OPEN_FORBID_CLOSED
-
STRICT_EXPAND_OPEN_HIDDEN_FORBID_CLOSED
-
STRICT_EXPAND_OPEN_FORBID_CLOSED_IGNORE_THROTTLED
-
STRICT_SINGLE_INDEX_NO_EXPAND_FORBID_CLOSED
-
STRICT_NO_EXPAND_FORBID_CLOSED
-
-
Constructor Details
-
IndicesOptions
public IndicesOptions(IndicesOptions.ConcreteTargetOptions concreteTargetOptions, IndicesOptions.WildcardOptions wildcardOptions, IndicesOptions.GeneralOptions generalOptions) Creates an instance of aIndicesOptions
record class.- Parameters:
concreteTargetOptions
- the value for theconcreteTargetOptions
record componentwildcardOptions
- the value for thewildcardOptions
record componentgeneralOptions
- the value for thegeneralOptions
record component
-
-
Method Details
-
builder
-
builder
-
allowNoIndices
public boolean allowNoIndices()- Returns:
- Whether to ignore if a wildcard expression resolves to no concrete indices. The `_all` string or empty list of indices count as wildcard expressions too. Also when an alias points to a closed index this option decides if no concrete indices are allowed.
-
expandWildcardsOpen
public boolean expandWildcardsOpen()- Returns:
- Whether wildcard expressions should get expanded to open indices
-
expandWildcardsClosed
public boolean expandWildcardsClosed()- Returns:
- Whether wildcard expressions should get expanded to closed indices
-
expandWildcardExpressions
public boolean expandWildcardExpressions()- Returns:
- whether wildcard expression should get expanded
-
expandWildcardsHidden
public boolean expandWildcardsHidden()- Returns:
- Whether wildcard expressions should get expanded to hidden indices
-
forbidClosedIndices
public boolean forbidClosedIndices()- Returns:
- Whether execution on closed indices is allowed.
-
allowAliasesToMultipleIndices
public boolean allowAliasesToMultipleIndices()- Returns:
- whether aliases pointing to multiple indices are allowed
-
ignoreAliases
public boolean ignoreAliases()- Returns:
- whether aliases should be ignored (when resolving a wildcard)
-
ignoreThrottled
public boolean ignoreThrottled()- Returns:
- whether indices that are marked as throttled should be ignored
-
writeIndicesOptions
- Throws:
IOException
-
readIndicesOptions
- Throws:
IOException
-
fromOptions
public static IndicesOptions fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices) -
fromOptions
public static IndicesOptions fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, boolean expandToHiddenIndices) -
fromOptions
public static IndicesOptions fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, IndicesOptions defaultOptions) -
fromOptions
public static IndicesOptions fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, boolean allowAliasesToMultipleIndices, boolean forbidClosedIndices, boolean ignoreAliases, boolean ignoreThrottled) -
fromOptions
public static IndicesOptions fromOptions(boolean ignoreUnavailable, boolean allowNoIndices, boolean expandToOpenIndices, boolean expandToClosedIndices, boolean expandToHiddenIndices, boolean allowAliasesToMultipleIndices, boolean forbidClosedIndices, boolean ignoreAliases, boolean ignoreThrottled) -
fromRequest
-
fromMap
-
isIndicesOptions
Returns true if the name represents a valid name for one of the indices option false otherwise -
fromParameters
public static IndicesOptions fromParameters(Object wildcardsString, Object ignoreUnavailableString, Object allowNoIndicesString, Object ignoreThrottled, IndicesOptions defaultSettings) -
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
fromXContent
- Throws:
IOException
-
fromXContent
public static IndicesOptions fromXContent(XContentParser parser, @Nullable IndicesOptions defaults) throws IOException - Throws:
IOException
-
strictExpandOpen
- Returns:
- indices options that requires every specified index to exist, expands wildcards only to open indices and allows that no indices are resolved from wildcard expressions (not returning an error).
-
strictExpandOpenAndForbidClosed
- Returns:
- indices options that requires every specified index to exist, expands wildcards only to open indices, allows that no indices are resolved from wildcard expressions (not returning an error) and forbids the use of closed indices by throwing an error.
-
strictExpandOpenAndForbidClosedIgnoreThrottled
- Returns:
- indices options that requires every specified index to exist, expands wildcards only to open indices, allows that no indices are resolved from wildcard expressions (not returning an error), forbids the use of closed indices by throwing an error and ignores indices that are throttled.
-
strictExpand
- Returns:
- indices option that requires every specified index to exist, expands wildcards to both open and closed indices and allows that no indices are resolved from wildcard expressions (not returning an error).
-
strictExpandHidden
- Returns:
- indices option that requires every specified index to exist, expands wildcards to both open and closed indices, includes hidden indices, and allows that no indices are resolved from wildcard expressions (not returning an error).
-
strictNoExpandForbidClosed
- Returns:
- indices option that requires each specified index or alias to exist, doesn't expand wildcards.
-
strictSingleIndexNoExpandForbidClosed
- Returns:
- indices option that requires each specified index or alias to exist, doesn't expand wildcards and throws error if any of the aliases resolves to multiple indices
-
lenientExpandOpen
- Returns:
- indices options that ignores unavailable indices, expands wildcards only to open indices and allows that no indices are resolved from wildcard expressions (not returning an error).
-
lenientExpandOpenHidden
- Returns:
- indices options that ignores unavailable indices, expands wildcards to open and hidden indices, and allows that no indices are resolved from wildcard expressions (not returning an error).
-
lenientExpand
- Returns:
- indices options that ignores unavailable indices, expands wildcards to both open and closed indices and allows that no indices are resolved from wildcard expressions (not returning an error).
-
lenientExpandHidden
- Returns:
- indices options that ignores unavailable indices, expands wildcards to all open and closed indices and allows that no indices are resolved from wildcard expressions (not returning an error).
-
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 withObjects::equals(Object,Object)
. -
concreteTargetOptions
Returns the value of theconcreteTargetOptions
record component.- Returns:
- the value of the
concreteTargetOptions
record component
-
wildcardOptions
Returns the value of thewildcardOptions
record component.- Returns:
- the value of the
wildcardOptions
record component
-
generalOptions
Returns the value of thegeneralOptions
record component.- Returns:
- the value of the
generalOptions
record component
-