Package org.elasticsearch.cluster.metadata

Enum IndexAbstraction.Type

java.lang.Object
java.lang.Enum<IndexAbstraction.Type>
org.elasticsearch.cluster.metadata.IndexAbstraction.Type
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<IndexAbstraction.Type>, java.lang.constant.Constable
Enclosing interface:
IndexAbstraction
public static enum IndexAbstraction.Type
extends java.lang.Enum<IndexAbstraction.Type>
An index abstraction type.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    ALIAS
    An index abstraction that refers to an alias.
    CONCRETE_INDEX
    An index abstraction that refers to a single concrete index.
    DATA_STREAM
    An index abstraction that refers to a data stream.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDisplayName()  
    static IndexAbstraction.Type valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static IndexAbstraction.Type[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • CONCRETE_INDEX

      public static final IndexAbstraction.Type CONCRETE_INDEX
      An index abstraction that refers to a single concrete index. This concrete index is also the write index.

    • ALIAS

      public static final IndexAbstraction.Type ALIAS
      An index abstraction that refers to an alias. An alias typically refers to many concrete indices and may have a write index.

    • DATA_STREAM

      public static final IndexAbstraction.Type DATA_STREAM
      An index abstraction that refers to a data stream. A data stream typically has multiple backing indices, the latest of which is the target for index requests.

  • Method Details

    • values

      public static IndexAbstraction.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static IndexAbstraction.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • getDisplayName

      public java.lang.String getDisplayName()