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

Enum SqlGatewayRestAPIVersion

  • All Implemented Interfaces:
    Serializable, Comparable<SqlGatewayRestAPIVersion>, org.apache.flink.runtime.rest.versioning.RestAPIVersion<SqlGatewayRestAPIVersion>, org.apache.flink.table.gateway.api.endpoint.EndpointVersion
    public enum SqlGatewayRestAPIVersion
extends Enum<SqlGatewayRestAPIVersion>
implements org.apache.flink.runtime.rest.versioning.RestAPIVersion<SqlGatewayRestAPIVersion>, org.apache.flink.table.gateway.api.endpoint.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)

    • 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 org.apache.flink.runtime.rest.versioning.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 org.apache.flink.runtime.rest.versioning.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 org.apache.flink.runtime.rest.versioning.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.