io.micronaut.management.endpoint.health

Enum DetailsVisibility

java.lang.Object

java.lang.Enum<DetailsVisibility>

io.micronaut.management.endpoint.health.DetailsVisibility

All Implemented Interfaces:

Serializable, Comparable<DetailsVisibility>

public enum DetailsVisibility
extends Enum<DetailsVisibility>

Options for controlling the visibility of health details.

Since:

1.0

Author:

James Kleeh

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static DetailsVisibility	valueOf(String name) Returns the enum constant of this type with the specified name.
static DetailsVisibility[]	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 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 Detail

values

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

Returns:

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

valueOf

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