Package org.elasticsearch.indices

Enum SystemIndexDescriptor.Type

java.lang.Object
java.lang.Enum<SystemIndexDescriptor.Type>
org.elasticsearch.indices.SystemIndexDescriptor.Type
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SystemIndexDescriptor.Type>, java.lang.constant.Constable
Enclosing class:
SystemIndexDescriptor
public static enum SystemIndexDescriptor.Type
extends java.lang.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.

  • 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
    EXTERNAL_MANAGED  
    EXTERNAL_UNMANAGED  
    INTERNAL_MANAGED  
    INTERNAL_UNMANAGED  

  • Method Summary

    Modifier and Type Method Description
    boolean isExternal()  
    boolean isInternal()  
    boolean isManaged()  
    static SystemIndexDescriptor.Type valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static SystemIndexDescriptor.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

  • Method Details

    • values

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

    • isExternal

      public boolean isExternal()

    • isManaged

      public boolean isManaged()

    • isInternal

      public boolean isInternal()