java.lang.Object
java.lang.Enum<ApiKey.Type>
org.elasticsearch.xpack.core.security.action.apikey.ApiKey.Type
All Implemented Interfaces:
Serializable, Comparable<ApiKey.Type>, Constable
Enclosing class:
ApiKey

public static enum ApiKey.Type extends Enum<ApiKey.Type>
  • Enum Constant Details

    • REST

      public static final ApiKey.Type REST
      REST type API keys can authenticate on the HTTP interface
    • CROSS_CLUSTER

      public static final ApiKey.Type CROSS_CLUSTER
      Cross cluster type API keys can authenticate on the dedicated remote cluster server interface
  • Method Details

    • values

      public static ApiKey.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 ApiKey.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
    • parse

      public static ApiKey.Type parse(String value)
    • fromXContent

      public static ApiKey.Type fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException
    • value

      public String value()