org.apache.flink.runtime.rest.versioning

枚举 RestAPIVersion

java.lang.Object

java.lang.Enum<RestAPIVersion>

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

所有已实现的接口:

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)

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	RestAPIVersion.RestAPIVersionComparator Comparator for RestAPIVersion that sorts versions based on their version number, i.e.

枚举常量概要

枚举常量

枚举常量和说明
V0
V1

方法概要

限定符和类型	方法和说明
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) 返回带有指定名称的该类型的枚举常量。
static RestAPIVersion[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

从类继承的方法 java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

V0

public static final RestAPIVersion V0

V1

public static final RestAPIVersion V1

方法详细资料

values

public static RestAPIVersion[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

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

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static RestAPIVersion valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

NullPointerException - 如果参数为空值

getURLVersionPrefix

public String getURLVersionPrefix()

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

返回:

URL version prefix

isDefaultVersion

public boolean isDefaultVersion()

Returns whether this version is the default REST API version.

返回:

whether this version is the default

isStableVersion

public boolean isStableVersion()

Returns whether this version is considered stable.

返回:

whether this version is stable

fromURLVersionPrefix

public static RestAPIVersion fromURLVersionPrefix(String prefix)

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

参数:

prefix - prefix to converted

返回:

REST API version matching the prefix

抛出:

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.

参数:

versions - possible candidates

返回:

latest version