Package io.micronaut.management.endpoint.annotation

Annotation Interface Endpoint

@Documented @Retention(RUNTIME) @Target(TYPE) @Singleton @ConfigurationReader(basePrefix="endpoints") @Requires(condition=EndpointEnabledCondition.class) public @interface Endpoint
Defines a management endpoint for a given ID.
Since:
1.0

  • Field Details

  • Element Details

    • value

      @AliasFor(annotation=io.micronaut.context.annotation.ConfigurationReader.class,member="prefix") @AliasFor(member="id") String value
      Returns:
      The ID of the endpoint
      Default:
      ""

    • id

      @AliasFor(member="value") @AliasFor(annotation=io.micronaut.context.annotation.ConfigurationReader.class,member="prefix") String id
      Returns:
      The ID of the endpoint
      Default:
      ""

    • prefix

      @AliasFor(annotation=io.micronaut.context.annotation.ConfigurationReader.class, member="basePrefix") String prefix
      Returns:
      The default prefix to use
      Default:
      "endpoints"

    • defaultEnabled

      boolean defaultEnabled
      Returns:
      If the endpoint is enabled when no configuration is provided
      Default:
      true

    • defaultSensitive

      boolean defaultSensitive
      Returns:
      If the endpoint is sensitive when no configuration is provided
      Default:
      true

    • defaultConfigurationId

      String defaultConfigurationId
      Returns:
      The configuration key to look for when no configuration is provided
      Default:
      "all"