Package io.envoyproxy.envoy.api.v2.core

Enum HealthStatus

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<HealthStatus>
    public enum HealthStatus
extends Enum<HealthStatus>
implements com.google.protobuf.ProtocolMessageEnum
     Endpoint health status.
    Protobuf enum envoy.api.v2.core.HealthStatus

    • Enum Constant Detail

      • UNKNOWN

        public static final HealthStatus UNKNOWN
         The health status is not known. This is interpreted by Envoy as *HEALTHY*.
        UNKNOWN = 0;

      • HEALTHY

        public static final HealthStatus HEALTHY
         Healthy.
        HEALTHY = 1;

      • UNHEALTHY

        public static final HealthStatus UNHEALTHY
         Unhealthy.
        UNHEALTHY = 2;

      • DRAINING

        public static final HealthStatus DRAINING
         Connection draining in progress. E.g.,
 `<https://aws.amazon.com/blogs/aws/elb-connection-draining-remove-instances-from-service-with-care/>`_
 or
 `<https://cloud.google.com/compute/docs/load-balancing/enabling-connection-draining>`_.
 This is interpreted by Envoy as *UNHEALTHY*.
        DRAINING = 3;

      • TIMEOUT

        public static final HealthStatus TIMEOUT
         Health check timed out. This is part of HDS and is interpreted by Envoy as
 *UNHEALTHY*.
        TIMEOUT = 4;

      • DEGRADED

        public static final HealthStatus DEGRADED
         Degraded.
        DEGRADED = 5;

      • UNRECOGNIZED

        public static final HealthStatus UNRECOGNIZED

    • Field Detail

      • UNKNOWN_VALUE

        public static final int UNKNOWN_VALUE
         The health status is not known. This is interpreted by Envoy as *HEALTHY*.
        UNKNOWN = 0;
        See Also:
        Constant Field Values

      • HEALTHY_VALUE

        public static final int HEALTHY_VALUE
         Healthy.
        HEALTHY = 1;
        See Also:
        Constant Field Values

      • UNHEALTHY_VALUE

        public static final int UNHEALTHY_VALUE
         Unhealthy.
        UNHEALTHY = 2;
        See Also:
        Constant Field Values

      • DRAINING_VALUE

        public static final int DRAINING_VALUE
         Connection draining in progress. E.g.,
 `<https://aws.amazon.com/blogs/aws/elb-connection-draining-remove-instances-from-service-with-care/>`_
 or
 `<https://cloud.google.com/compute/docs/load-balancing/enabling-connection-draining>`_.
 This is interpreted by Envoy as *UNHEALTHY*.
        DRAINING = 3;
        See Also:
        Constant Field Values

      • TIMEOUT_VALUE

        public static final int TIMEOUT_VALUE
         Health check timed out. This is part of HDS and is interpreted by Envoy as
 *UNHEALTHY*.
        TIMEOUT = 4;
        See Also:
        Constant Field Values

      • DEGRADED_VALUE

        public static final int DEGRADED_VALUE
         Degraded.
        DEGRADED = 5;
        See Also:
        Constant Field Values

    • Method Detail

      • values

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

      • valueOf

        public static HealthStatus valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static HealthStatus valueOf​(int value)
        Deprecated.
        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:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • forNumber

        public static HealthStatus forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • internalGetValueMap

        public static com.google.protobuf.Internal.EnumLiteMap<HealthStatus> internalGetValueMap()

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static HealthStatus valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        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:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null