Package io.micronaut.management.endpoint

Class EndpointConfiguration

  • @EachProperty("endpoints")
public class EndpointConfiguration
extends java.lang.Object
    An Endpoint configuration.
    Since:
    1.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PREFIX
      The prefix for endpoints configurations.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getId()  
      java.util.Optional<java.lang.Boolean> isEnabled()  
      java.util.Optional<java.lang.Boolean> isSensitive()  
      void setEnabled​(java.lang.Boolean enabled)
      Sets whether the endpoint is enabled.
      void setSensitive​(java.lang.Boolean sensitive)
      Sets whether the endpoint is sensitive.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • PREFIX

        public static final java.lang.String PREFIX
        The prefix for endpoints configurations.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EndpointConfiguration

        public EndpointConfiguration​(@Parameter
                             java.lang.String id,
                             EndpointDefaultConfiguration defaultConfiguration)
        Parameters:
        id - The id of the endpoint
        defaultConfiguration - The default endpoint configuration

    • Method Detail

      • getId

        public java.lang.String getId()
        Returns:
        The ID of the endpoint
        See Also:
        Endpoint.value()

      • isEnabled

        public java.util.Optional<java.lang.Boolean> isEnabled()
        Returns:
        Is the endpoint enabled. If not present, use the value of Endpoint.defaultEnabled()

      • isSensitive

        public java.util.Optional<java.lang.Boolean> isSensitive()
        Returns:
        Does the endpoint expose sensitive information. If not present, use the value of Endpoint.defaultSensitive()

      • setEnabled

        public void setEnabled​(java.lang.Boolean enabled)
        Sets whether the endpoint is enabled.
        Parameters:
        enabled - True it is enabled, null for the default behaviour

      • setSensitive

        public void setSensitive​(java.lang.Boolean sensitive)
        Sets whether the endpoint is sensitive.
        Parameters:
        sensitive - True it is sensitive, null for the default behaviour