org.springframework.boot.actuate.endpoint.http

Enum ApiVersion

java.lang.Object

java.lang.Enum<ApiVersion>

org.springframework.boot.actuate.endpoint.http.ApiVersion

All Implemented Interfaces:

Serializable, Comparable<ApiVersion>

public enum ApiVersion
extends Enum<ApiVersion>

API versions supported for the actuator HTTP API. This enum may be injected into actuator endpoints in order to return a response compatible with the requested version.

Since:

2.2.0

Author:

Phillip Webb

Enum Constant Summary

Enum Constants

Enum Constant and Description
V2 Version 2 (supported by Spring Boot 2.0+).
V3 Version 3 (supported by Spring Boot 2.2+).

Field Summary

Fields

Modifier and Type	Field and Description
static ApiVersion	LATEST The latest API version.

Method Summary

Modifier and Type	Method and Description
static ApiVersion	fromHttpHeaders(Map<String,List<String>> headers) Return the ApiVersion to use based on the HTTP request headers.
static ApiVersion	valueOf(String name) Returns the enum constant of this type with the specified name.
static ApiVersion[]	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

V2

public static final ApiVersion V2

Version 2 (supported by Spring Boot 2.0+).

V3

public static final ApiVersion V3

Version 3 (supported by Spring Boot 2.2+).

Field Detail

LATEST

public static final ApiVersion LATEST

The latest API version.

Method Detail

values

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

Returns:

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

valueOf

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

fromHttpHeaders

public static ApiVersion fromHttpHeaders(Map<String,List<String>> headers)

Return the ApiVersion to use based on the HTTP request headers. The version will be deduced based on the Accept header.

Parameters:

headers - the HTTP headers

Returns:

the API version to use