Package org.elasticsearch.core

Enum Class RestApiVersion

java.lang.Object

java.lang.Enum<RestApiVersion>

org.elasticsearch.core.RestApiVersion

All Implemented Interfaces:

Serializable, Comparable<RestApiVersion>, Constable

public enum RestApiVersion
extends Enum<RestApiVersion>

A enum representing versions of the REST API (particularly with regard to backwards compatibility). Only major versions are supported.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
V_7
V_8

Field Summary

Fields

Modifier and Type	Field	Description
final byte	major

Method Summary

Modifier and Type	Method	Description
static RestApiVersion	current()
static Function<RestApiVersion,Boolean>	equalTo(RestApiVersion restApiVersion)
boolean	matches(Function<RestApiVersion,Boolean> restApiVersionFunctions)
static RestApiVersion	minimumSupported()
static Function<RestApiVersion,Boolean>	onOrAfter(RestApiVersion restApiVersion)
RestApiVersion	previous()
static RestApiVersion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RestApiVersion[]	values()	Returns an array containing the constants of this enum class, 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

V_8

public static final RestApiVersion V_8

V_7

public static final RestApiVersion V_7

Field Details

major

public final byte major

Method Details

values

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

previous

public RestApiVersion previous()

matches

public boolean matches(Function<RestApiVersion,Boolean> restApiVersionFunctions)

minimumSupported

public static RestApiVersion minimumSupported()

current

public static RestApiVersion current()

equalTo

public static Function<RestApiVersion,Boolean> equalTo(RestApiVersion restApiVersion)

onOrAfter

public static Function<RestApiVersion,Boolean> onOrAfter(RestApiVersion restApiVersion)