Package com.unboundid.directory.sdk.proxy.types

Enum HealthCheckState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<HealthCheckState>
    public enum HealthCheckState
extends java.lang.Enum<HealthCheckState>
    This enum defines the set of possible states that may be returned by LDAP health checks.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AVAILABLE
      The health check state that indicates that the associated server is fully available for use.
      DEGRADED
      The health check state that indicates that the associated server is in a degraded state and should be avoided if another server may be more suitable.
      UNAVAILABLE
      The health check state that indicates that the associated server is not available and must not be used.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static HealthCheckState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HealthCheckState[] 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

      • AVAILABLE

        public static final HealthCheckState AVAILABLE
        The health check state that indicates that the associated server is fully available for use.

      • DEGRADED

        public static final HealthCheckState DEGRADED
        The health check state that indicates that the associated server is in a degraded state and should be avoided if another server may be more suitable.

      • UNAVAILABLE

        public static final HealthCheckState UNAVAILABLE
        The health check state that indicates that the associated server is not available and must not be used.

    • Method Detail

      • values

        public static HealthCheckState[] 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 (HealthCheckState c : HealthCheckState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static HealthCheckState 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