Package org.elasticsearch.indices

Enum Class SystemIndexDescriptor.Type

java.lang.Object
java.lang.Enum<SystemIndexDescriptor.Type>
org.elasticsearch.indices.SystemIndexDescriptor.Type
All Implemented Interfaces:
Serializable, Comparable<SystemIndexDescriptor.Type>, Constable
Enclosing class:
SystemIndexDescriptor
public static enum SystemIndexDescriptor.Type extends Enum<SystemIndexDescriptor.Type>
The specific type of system index that this descriptor represents. System indices can be one of four defined types; the type is used to control behavior. Elasticsearch itself and plugins have system indices that are necessary for their features; these system indices are referred to as internal system indices. System indices can also belong to features outside of Elasticsearch that may be part of other Elastic stack components. These are external system indices as the intent is for these to be accessed via normal APIs with a special value. Within both internal and external system indices, there are two sub-types. The first are those that are managed by Elasticsearch and will have mappings/settings changed as the cluster itself is upgraded. The second are those managed by the owning applications code and for those Elasticsearch will not perform any updates. Internal system indices are almost always managed indices that Elasticsearch manages, but there are cases where the component of Elasticsearch will need to manage the system indices itself.

  • Enum Constant Details

  • Method Details

    • values

      public static SystemIndexDescriptor.Type[] 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 SystemIndexDescriptor.Type 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

    • isExternal

      public boolean isExternal()

    • isManaged

      public boolean isManaged()

    • isInternal

      public boolean isInternal()