org.apache.flink.table.gateway.rest.util

Enum SqlGatewayRestAPIVersion

java.lang.Object

java.lang.Enum<SqlGatewayRestAPIVersion>

org.apache.flink.table.gateway.rest.util.SqlGatewayRestAPIVersion

All Implemented Interfaces:

Serializable, Comparable<SqlGatewayRestAPIVersion>, RestAPIVersion<SqlGatewayRestAPIVersion>, EndpointVersion

public enum SqlGatewayRestAPIVersion
extends Enum<SqlGatewayRestAPIVersion>
implements RestAPIVersion<SqlGatewayRestAPIVersion>, EndpointVersion

An enum for all versions of the Sql Gateway REST API.

Sql Gateway 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 and Description
V0
V1
V2

Method Summary

Modifier and Type	Method and Description
static SqlGatewayRestAPIVersion	fromURIToVersion(String uri) Convert uri to SqlGatewayRestAPIVersion.
static SqlGatewayRestAPIVersion	getDefaultVersion() Returns the default version.
static List<SqlGatewayRestAPIVersion>	getStableVersions() Returns the supported stable versions.
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 SqlGatewayRestAPIVersion	valueOf(String name) Returns the enum constant of this type with the specified name.
static SqlGatewayRestAPIVersion[]	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 org.apache.flink.runtime.rest.versioning.RestAPIVersion

getLatestVersion

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

V0

public static final SqlGatewayRestAPIVersion V0

V1

public static final SqlGatewayRestAPIVersion V1

V2

public static final SqlGatewayRestAPIVersion V2

Method Detail

values

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

Returns:

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

valueOf

public static SqlGatewayRestAPIVersion 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<SqlGatewayRestAPIVersion>

Returns:

URL version prefix

isDefaultVersion

public boolean isDefaultVersion()

Returns whether this version is the default REST API version.

Specified by:

isDefaultVersion in interface RestAPIVersion<SqlGatewayRestAPIVersion>

Returns:

whether this version is the default

isStableVersion

public boolean isStableVersion()

Returns whether this version is considered stable.

Specified by:

isStableVersion in interface RestAPIVersion<SqlGatewayRestAPIVersion>

Returns:

whether this version is stable

fromURIToVersion

public static SqlGatewayRestAPIVersion fromURIToVersion(String uri)

Convert uri to SqlGatewayRestAPIVersion. If failed, return default version.

Returns:

SqlGatewayRestAPIVersion

getStableVersions

public static List<SqlGatewayRestAPIVersion> getStableVersions()

Returns the supported stable versions.

Returns:

the list of the stable versions.

getDefaultVersion

public static SqlGatewayRestAPIVersion getDefaultVersion()

Returns the default version.

Returns:

the default version.