org.springframework.boot.actuate.health

Enum ShowDetails

java.lang.Object

java.lang.Enum<ShowDetails>

org.springframework.boot.actuate.health.ShowDetails

All Implemented Interfaces:

Serializable, Comparable<ShowDetails>

public enum ShowDetails
extends Enum<ShowDetails>

Options for showing details in responses from the HealthEndpoint web extensions.

Since:

2.0.0

Author:

Andy Wilkinson

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Always show details in the response.
NEVER Never show details in the response.
WHEN_AUTHORIZED Show details in the response when accessed by an authorized user.

Method Summary

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

NEVER

public static final ShowDetails NEVER

Never show details in the response.

WHEN_AUTHORIZED

public static final ShowDetails WHEN_AUTHORIZED

Show details in the response when accessed by an authorized user.

ALWAYS

public static final ShowDetails ALWAYS

Always show details in the response.

Method Detail

values

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

Returns:

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

valueOf

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