Package org.apache.flink.runtime.rest.versioning

Enum RuntimeRestAPIVersion

java.lang.Object

java.lang.Enum<RuntimeRestAPIVersion>

org.apache.flink.runtime.rest.versioning.RuntimeRestAPIVersion

All Implemented Interfaces:

Serializable, Comparable<RuntimeRestAPIVersion>, RestAPIVersion<RuntimeRestAPIVersion>

public enum RuntimeRestAPIVersion
extends Enum<RuntimeRestAPIVersion>
implements RestAPIVersion<RuntimeRestAPIVersion>

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)

Enum Constant Summary

Enum Constants

Enum Constant	Description
V0
V1

Method Summary

Modifier and Type	Method	Description
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 RuntimeRestAPIVersion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RuntimeRestAPIVersion[]	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

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

V0

public static final RuntimeRestAPIVersion V0

V1

public static final RuntimeRestAPIVersion V1

Method Detail

values

public static RuntimeRestAPIVersion[] 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 (RuntimeRestAPIVersion c : RuntimeRestAPIVersion.values())
    System.out.println(c);

Returns:

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

valueOf

public static RuntimeRestAPIVersion 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.

Specified by:

getURLVersionPrefix in interface RestAPIVersion<RuntimeRestAPIVersion>

Returns:

URL version prefix

isDefaultVersion

public boolean isDefaultVersion()

Returns whether this version is the default REST API version.

Specified by:

isDefaultVersion in interface RestAPIVersion<RuntimeRestAPIVersion>

Returns:

whether this version is the default

isStableVersion

public boolean isStableVersion()

Returns whether this version is considered stable.

Specified by:

isStableVersion in interface RestAPIVersion<RuntimeRestAPIVersion>

Returns:

whether this version is stable