Package com.orbitz.consul.model

Enum State

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<State>, java.lang.constant.Constable
    public enum State
extends java.lang.Enum<State>
    Represents the possible Check states.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.lang.Enum

        java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

    • Method Summary

      Modifier and Type Method Description
      static State fromName​(java.lang.String name)
      Returns the appropriate State given the name.
      java.lang.String getName()
      Retrieve the name value for the Consul check API endpoints.
      java.lang.String getPath()
      Retrieve the path value for the Consul check API endpoints.
      static State valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static State[] 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • PASS

        public static final State PASS

      • WARN

        public static final State WARN

      • FAIL

        public static final State FAIL

      • ANY

        public static final State ANY

      • UNKNOWN

        public static final State UNKNOWN

    • Method Detail

      • values

        public static State[] values()
        Returns an array containing the constants of this enum type, in the order they are declared.
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

      • getPath

        public java.lang.String getPath()
        Retrieve the path value for the Consul check API endpoints.
        Returns:
        The path value, e.g. "pass" for PASS.

      • getName

        public java.lang.String getName()
        Retrieve the name value for the Consul check API endpoints. This is the value to use for querying services by health state.
        Returns:
        The name, e.g. "passing" for PASS.

      • fromName

        public static State fromName​(java.lang.String name)
        Returns the appropriate State given the name.
        Parameters:
        name - The state name e.g. "passing".
        Returns:
        The state.