Interface HealthEndpointGroups

public interface HealthEndpointGroups
A collection of groups for use with a health endpoint.
Since:
4.0.0

  • Method Details

    • getPrimary

      HealthEndpointGroup getPrimary()
      Return the primary group used by the endpoint.
      Returns:
      the primary group (never null)

    • getNames

      Set<String> getNames()
      Return the names of any additional groups.
      Returns:
      the additional group names

    • get

      @Nullable HealthEndpointGroup get(String name)
      Return the group with the specified name or null if the name is not known.
      Parameters:
      name - the name of the group
      Returns:
      the HealthEndpointGroup or null

    • get

      default @Nullable HealthEndpointGroup get(AdditionalHealthEndpointPath path)
      Return the group with the specified additional path or null if no group with that path is found.
      Parameters:
      path - the additional path
      Returns:
      the matching HealthEndpointGroup or null

    • getAllWithAdditionalPath

      default Set<HealthEndpointGroup> getAllWithAdditionalPath(org.springframework.boot.actuate.endpoint.web.WebServerNamespace namespace)
      Return all the groups with an additional path on the specified WebServerNamespace.
      Parameters:
      namespace - the WebServerNamespace
      Returns:
      the matching groups

    • of

      static HealthEndpointGroups of(HealthEndpointGroup primary, Map<String, HealthEndpointGroup> additional)
      Factory method to create a HealthEndpointGroups instance.
      Parameters:
      primary - the primary group
      additional - the additional groups
      Returns:
      a new HealthEndpointGroups instance