Module org.elasticsearch.xcore
Enum Class ApiKey.Type
- All Implemented Interfaces:
Serializable,Comparable<ApiKey.Type>,Constable
- Enclosing class:
ApiKey
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionCross cluster type API keys can authenticate on the dedicated remote cluster server interfaceREST type API keys can authenticate on the HTTP interface -
Method Summary
Modifier and TypeMethodDescriptionstatic ApiKey.TypefromXContent(org.elasticsearch.xcontent.XContentParser parser) static ApiKey.Typevalue()static ApiKey.TypeReturns the enum constant of this class with the specified name.static ApiKey.Type[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
REST
REST type API keys can authenticate on the HTTP interface -
CROSS_CLUSTER
Cross cluster type API keys can authenticate on the dedicated remote cluster server interface
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
parse
-
fromXContent
public static ApiKey.Type fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException - Throws:
IOException
-
value
-