Module org.elasticsearch.server
Package org.elasticsearch.action.support
Enum Class IndexComponentSelector
- All Implemented Interfaces:
Serializable,Comparable<IndexComponentSelector>,Constable,Writeable
We define as index components the two different sets of indices a data stream could consist of:
- DATA: represents the backing indices
- FAILURES: represent the failing indices
Note: An index is its own DATA component, but it cannot have a FAILURE component.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionstatic IndexComponentSelectorRetrieves the respective selector when the suffix key is recognisedstatic IndexComponentSelectorgetByKeyOrThrow(String key) LikegetByKey(String)but throws an exception if the key is not recognised.bytegetId()getKey()static IndexComponentSelectorread(StreamInput in) booleanbooleanstatic IndexComponentSelectorReturns the enum constant of this class with the specified name.static IndexComponentSelector[]values()Returns an array containing the constants of this enum class, in the order they are declared.voidwriteTo(StreamOutput out) Write this into the StreamOutput.
-
Enum Constant Details
-
DATA
-
FAILURES
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
getKey
-
getId
public byte getId() -
getByKey
Retrieves the respective selector when the suffix key is recognised- Parameters:
key- the suffix key, probably parsed from an expression- Returns:
- the selector or null if the key was not recognised.
-
getByKeyOrThrow
LikegetByKey(String)but throws an exception if the key is not recognised.- Returns:
- the selector if recognized. `null` input will return `DATA`.
- Throws:
IllegalArgumentException- if the key was not recognised.
-
read
- Throws:
IOException
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
shouldIncludeData
public boolean shouldIncludeData() -
shouldIncludeFailures
public boolean shouldIncludeFailures()
-