org.apache.flink.runtime.rest.versioning

Enum RestAPIVersion

java.lang.Object

java.lang.Enum<RestAPIVersion>

org.apache.flink.runtime.rest.versioning.RestAPIVersion

All Implemented Interfaces:

Serializable, Comparable<RestAPIVersion>

public enum RestAPIVersion
extends Enum<RestAPIVersion>

An enum for all versions of the REST API.

REST API versions are global and thus apply to every REST component.

Changes that must result in an API version increment include but are not limited to: - modification of a handler url - addition of new mandatory parameters - removal of a handler/request - modifications to request/response bodies (excluding additions)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestAPIVersion.RestAPIVersionComparator Comparator for RestAPIVersion that sorts versions based on their version number, i.e.

Enum Constant Summary

Enum Constants

Enum Constant and Description
V0
V1

Method Summary

Modifier and Type	Method and Description
static RestAPIVersion	fromURLVersionPrefix(String prefix) Converts the given URL version prefix (e.g "v1") to a RestAPIVersion.
static RestAPIVersion	getLatestVersion(Collection<RestAPIVersion> versions) Returns the latest version from the given collection.
String	getURLVersionPrefix() Returns the URL version prefix (e.g.
boolean	isDefaultVersion() Returns whether this version is the default REST API version.
boolean	isStableVersion() Returns whether this version is considered stable.
static RestAPIVersion	valueOf(String name) Returns the enum constant of this type with the specified name.
static RestAPIVersion[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

V0

public static final RestAPIVersion V0

V1

public static final RestAPIVersion V1

Method Detail

values

public static RestAPIVersion[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RestAPIVersion c : RestAPIVersion.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RestAPIVersion valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getURLVersionPrefix

public String getURLVersionPrefix()

Returns the URL version prefix (e.g. "v1") for this version.

Returns:

URL version prefix

isDefaultVersion

public boolean isDefaultVersion()

Returns whether this version is the default REST API version.

Returns:

whether this version is the default

isStableVersion

public boolean isStableVersion()

Returns whether this version is considered stable.

Returns:

whether this version is stable

fromURLVersionPrefix

public static RestAPIVersion fromURLVersionPrefix(String prefix)

Converts the given URL version prefix (e.g "v1") to a RestAPIVersion.

Parameters:

prefix - prefix to converted

Returns:

REST API version matching the prefix

Throws:

IllegalArgumentException - if the prefix doesn't match any version

getLatestVersion

public static RestAPIVersion getLatestVersion(Collection<RestAPIVersion> versions)

Returns the latest version from the given collection.

Parameters:

versions - possible candidates

Returns:

latest version