Package io.smallrye.health.api

Interface HealthContentFilter

Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface @Experimental("Health content filtering") public interface HealthContentFilter
Implementations of this interface are invoked prior the health report to filter(remove, add, or modify) fields in the returned JSON object. Individual implementations are collected through CDI so they must be annotated with some of the bean-defining annotations (e.g., ApplicationScoped).

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.json.JsonObject
    filter(jakarta.json.JsonObject payload)
    Filters (removes, adds, or modifies) fields in the provided JsonObject.

  • Method Details

    • filter

      jakarta.json.JsonObject filter(jakarta.json.JsonObject payload)
      Filters (removes, adds, or modifies) fields in the provided JsonObject.
      Parameters:
      payload - An object representing the payload to be reported to the caller.