Package io.micronaut.management.endpoint.health

Enum Class DetailsVisibility

java.lang.Object

java.lang.Enum<DetailsVisibility>

io.micronaut.management.endpoint.health.DetailsVisibility

All Implemented Interfaces:

Serializable, Comparable<DetailsVisibility>, Constable

public enum DetailsVisibility
extends Enum<DetailsVisibility>

Options for controlling the visibility of health details.

Since:

1.0

Author:

James Kleeh

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANONYMOUS	Show health details to all users.
AUTHENTICATED	Only show health details to authenticated users.
NEVER	Never show health details.

Method Summary

Modifier and Type	Method	Description
static DetailsVisibility	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DetailsVisibility[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NEVER

public static final DetailsVisibility NEVER

Never show health details.

AUTHENTICATED

public static final DetailsVisibility AUTHENTICATED

Only show health details to authenticated users.

ANONYMOUS

public static final DetailsVisibility ANONYMOUS

Show health details to all users. If the health endpoint is sensitive, it will still require authentication.

Method Details

values

public static DetailsVisibility[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DetailsVisibility valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null