Package io.envoyproxy.envoy.admin.v3

Interface HostHealthStatusOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HostHealthStatus, HostHealthStatus.Builder
public interface HostHealthStatusOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getActiveHcTimeout()
    The host failed active health check due to timeout.
    HealthStatus
    getEdsHealthStatus()
    Health status as reported by EDS. .. note:: Currently, only ``HEALTHY`` and ``UNHEALTHY`` are supported.
    int
    getEdsHealthStatusValue()
    Health status as reported by EDS. .. note:: Currently, only ``HEALTHY`` and ``UNHEALTHY`` are supported.
    boolean
    getExcludedViaImmediateHcFail()
    The host should be excluded from panic, spillover, etc. calculations because it was explicitly taken out of rotation via protocol signal and is not meant to be routed to.
    boolean
    getFailedActiveDegradedCheck()
    The host is currently being marked as degraded through active health checking.
    boolean
    getFailedActiveHealthCheck()
    The host is currently failing active health checks.
    boolean
    getFailedOutlierCheck()
    The host is currently considered an outlier and has been ejected.
    boolean
    getPendingActiveHc()
    The host is awaiting first health check.
    boolean
    getPendingDynamicRemoval()
    The host has been removed from service discovery, but is being stabilized due to active health checking.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getFailedActiveHealthCheck

      boolean getFailedActiveHealthCheck()
       The host is currently failing active health checks.
      bool failed_active_health_check = 1;
      Returns:
      The failedActiveHealthCheck.

    • getFailedOutlierCheck

      boolean getFailedOutlierCheck()
       The host is currently considered an outlier and has been ejected.
      bool failed_outlier_check = 2;
      Returns:
      The failedOutlierCheck.

    • getFailedActiveDegradedCheck

      boolean getFailedActiveDegradedCheck()
       The host is currently being marked as degraded through active health checking.
      bool failed_active_degraded_check = 4;
      Returns:
      The failedActiveDegradedCheck.

    • getPendingDynamicRemoval

      boolean getPendingDynamicRemoval()
       The host has been removed from service discovery, but is being stabilized due to active
 health checking.
      bool pending_dynamic_removal = 5;
      Returns:
      The pendingDynamicRemoval.

    • getPendingActiveHc

      boolean getPendingActiveHc()
       The host is awaiting first health check.
      bool pending_active_hc = 6;
      Returns:
      The pendingActiveHc.

    • getExcludedViaImmediateHcFail

      boolean getExcludedViaImmediateHcFail()
       The host should be excluded from panic, spillover, etc. calculations because it was explicitly
 taken out of rotation via protocol signal and is not meant to be routed to.
      bool excluded_via_immediate_hc_fail = 7;
      Returns:
      The excludedViaImmediateHcFail.

    • getActiveHcTimeout

      boolean getActiveHcTimeout()
       The host failed active health check due to timeout.
      bool active_hc_timeout = 8;
      Returns:
      The activeHcTimeout.

    • getEdsHealthStatusValue

      int getEdsHealthStatusValue()
       Health status as reported by EDS.

 .. note::

   Currently, only ``HEALTHY`` and ``UNHEALTHY`` are supported.

 [#comment:TODO(mrice32): pipe through remaining EDS health status possibilities.]
      .envoy.config.core.v3.HealthStatus eds_health_status = 3;
      Returns:
      The enum numeric value on the wire for edsHealthStatus.

    • getEdsHealthStatus

      HealthStatus getEdsHealthStatus()
       Health status as reported by EDS.

 .. note::

   Currently, only ``HEALTHY`` and ``UNHEALTHY`` are supported.

 [#comment:TODO(mrice32): pipe through remaining EDS health status possibilities.]
      .envoy.config.core.v3.HealthStatus eds_health_status = 3;
      Returns:
      The edsHealthStatus.