Package io.micronaut.management.endpoint.health

Enum DetailsVisibility

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DetailsVisibility>
    public enum DetailsVisibility
extends java.lang.Enum<DetailsVisibility>
    Options for controlling the visibility of health details.
    Since:
    1.0

    • 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static DetailsVisibility valueOf​(java.lang.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

      • 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​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null