Module org.elasticsearch.server
Package org.elasticsearch.common

Enum Class ReferenceDocs

java.lang.Object
java.lang.Enum<ReferenceDocs>
org.elasticsearch.common.ReferenceDocs
All Implemented Interfaces:
Serializable, Comparable<ReferenceDocs>, Constable
public enum ReferenceDocs extends Enum<ReferenceDocs>
Encapsulates links to pages in the reference docs, so that for example we can include URLs in logs and API outputs. Each instance's toString() yields (a string representation of) a URL for the relevant docs. Links are defined in the resource file reference-docs-links.json which must include definitions for exactly the set of values of this enum.

  • Enum Constant Details

    • INITIAL_MASTER_NODES

      public static final ReferenceDocs INITIAL_MASTER_NODES

    • DISCOVERY_TROUBLESHOOTING

      public static final ReferenceDocs DISCOVERY_TROUBLESHOOTING

    • UNSTABLE_CLUSTER_TROUBLESHOOTING

      public static final ReferenceDocs UNSTABLE_CLUSTER_TROUBLESHOOTING

    • LAGGING_NODE_TROUBLESHOOTING

      public static final ReferenceDocs LAGGING_NODE_TROUBLESHOOTING

    • SHARD_LOCK_TROUBLESHOOTING

      public static final ReferenceDocs SHARD_LOCK_TROUBLESHOOTING

    • CONCURRENT_REPOSITORY_WRITERS

      public static final ReferenceDocs CONCURRENT_REPOSITORY_WRITERS

    • ARCHIVE_INDICES

      public static final ReferenceDocs ARCHIVE_INDICES

    • HTTP_TRACER

      public static final ReferenceDocs HTTP_TRACER

  • Method Details

    • values

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

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ReferenceDocs>