Enum Class IndexComponentSelector

java.lang.Object
java.lang.Enum<IndexComponentSelector>
org.elasticsearch.action.support.IndexComponentSelector
All Implemented Interfaces:
Serializable, Comparable<IndexComponentSelector>, Constable, Writeable

public enum IndexComponentSelector extends Enum<IndexComponentSelector> implements 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.
  • Enum Constant Details

  • Method Details

    • values

      public static IndexComponentSelector[] 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

      public static IndexComponentSelector valueOf(String name)
      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 name
      NullPointerException - if the argument is null
    • getKey

      public String getKey()
    • getId

      public byte getId()
    • getByKey

      @Nullable public static IndexComponentSelector getByKey(String key)
      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.
    • read

      public static IndexComponentSelector read(StreamInput in) throws IOException
      Throws:
      IOException
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • shouldIncludeData

      public boolean shouldIncludeData()
    • shouldIncludeFailures

      public boolean shouldIncludeFailures()