Package io.envoyproxy.envoy.admin.v3

Interface HostStatusOrBuilder

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

  • Method Details

    • hasAddress

      boolean hasAddress()
       Address of this host.
      .envoy.config.core.v3.Address address = 1;
      Returns:
      Whether the address field is set.

    • getAddress

      Address getAddress()
       Address of this host.
      .envoy.config.core.v3.Address address = 1;
      Returns:
      The address.

    • getAddressOrBuilder

      AddressOrBuilder getAddressOrBuilder()
       Address of this host.
      .envoy.config.core.v3.Address address = 1;

    • getStatsList

      List<SimpleMetric> getStatsList()
       List of stats specific to this host.
      repeated .envoy.admin.v3.SimpleMetric stats = 2;

    • getStats

      SimpleMetric getStats(int index)
       List of stats specific to this host.
      repeated .envoy.admin.v3.SimpleMetric stats = 2;

    • getStatsCount

      int getStatsCount()
       List of stats specific to this host.
      repeated .envoy.admin.v3.SimpleMetric stats = 2;

    • getStatsOrBuilderList

      List<? extends SimpleMetricOrBuilder> getStatsOrBuilderList()
       List of stats specific to this host.
      repeated .envoy.admin.v3.SimpleMetric stats = 2;

    • getStatsOrBuilder

      SimpleMetricOrBuilder getStatsOrBuilder(int index)
       List of stats specific to this host.
      repeated .envoy.admin.v3.SimpleMetric stats = 2;

    • hasHealthStatus

      boolean hasHealthStatus()
       The host's current health status.
      .envoy.admin.v3.HostHealthStatus health_status = 3;
      Returns:
      Whether the healthStatus field is set.

    • getHealthStatus

      HostHealthStatus getHealthStatus()
       The host's current health status.
      .envoy.admin.v3.HostHealthStatus health_status = 3;
      Returns:
      The healthStatus.

    • getHealthStatusOrBuilder

      HostHealthStatusOrBuilder getHealthStatusOrBuilder()
       The host's current health status.
      .envoy.admin.v3.HostHealthStatus health_status = 3;

    • hasSuccessRate

      boolean hasSuccessRate()
       The success rate for this host during the last measurement interval.

 * If :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
   is ``false``, all errors: externally and locally generated were used in success rate calculation.
 * If :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
   is ``true``, only externally generated errors were used in success rate calculation.

 For more information, see the :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation.

 .. note::

   The message will be missing if the host didn't receive enough traffic to calculate a reliable success rate, or
   if the cluster had too few hosts to apply outlier ejection based on success rate.
      .envoy.type.v3.Percent success_rate = 4;
      Returns:
      Whether the successRate field is set.

    • getSuccessRate

      Percent getSuccessRate()
       The success rate for this host during the last measurement interval.

 * If :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
   is ``false``, all errors: externally and locally generated were used in success rate calculation.
 * If :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
   is ``true``, only externally generated errors were used in success rate calculation.

 For more information, see the :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation.

 .. note::

   The message will be missing if the host didn't receive enough traffic to calculate a reliable success rate, or
   if the cluster had too few hosts to apply outlier ejection based on success rate.
      .envoy.type.v3.Percent success_rate = 4;
      Returns:
      The successRate.

    • getSuccessRateOrBuilder

      PercentOrBuilder getSuccessRateOrBuilder()
       The success rate for this host during the last measurement interval.

 * If :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
   is ``false``, all errors: externally and locally generated were used in success rate calculation.
 * If :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
   is ``true``, only externally generated errors were used in success rate calculation.

 For more information, see the :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation.

 .. note::

   The message will be missing if the host didn't receive enough traffic to calculate a reliable success rate, or
   if the cluster had too few hosts to apply outlier ejection based on success rate.
      .envoy.type.v3.Percent success_rate = 4;

    • getWeight

      int getWeight()
       The host's weight. If not configured, the value defaults to 1.
      uint32 weight = 5;
      Returns:
      The weight.

    • getHostname

      String getHostname()
       The hostname of the host, if applicable.
      string hostname = 6;
      Returns:
      The hostname.

    • getHostnameBytes

      com.google.protobuf.ByteString getHostnameBytes()
       The hostname of the host, if applicable.
      string hostname = 6;
      Returns:
      The bytes for hostname.

    • getPriority

      int getPriority()
       The host's priority. If not configured, the value defaults to 0 (highest priority).
      uint32 priority = 7;
      Returns:
      The priority.

    • hasLocalOriginSuccessRate

      boolean hasLocalOriginSuccessRate()
       The success rate for this host during the last interval, considering only locally generated errors. Externally
 generated errors are treated as successes.

 This field is only relevant when
 :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
 is set to ``true``.

 For more information, see the :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation.

 .. note::

   The message will be missing if the host didn't receive enough traffic to compute a success rate, or if the
   cluster didn't have enough hosts to perform outlier ejection based on success rate.
      .envoy.type.v3.Percent local_origin_success_rate = 8;
      Returns:
      Whether the localOriginSuccessRate field is set.

    • getLocalOriginSuccessRate

      Percent getLocalOriginSuccessRate()
       The success rate for this host during the last interval, considering only locally generated errors. Externally
 generated errors are treated as successes.

 This field is only relevant when
 :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
 is set to ``true``.

 For more information, see the :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation.

 .. note::

   The message will be missing if the host didn't receive enough traffic to compute a success rate, or if the
   cluster didn't have enough hosts to perform outlier ejection based on success rate.
      .envoy.type.v3.Percent local_origin_success_rate = 8;
      Returns:
      The localOriginSuccessRate.

    • getLocalOriginSuccessRateOrBuilder

      PercentOrBuilder getLocalOriginSuccessRateOrBuilder()
       The success rate for this host during the last interval, considering only locally generated errors. Externally
 generated errors are treated as successes.

 This field is only relevant when
 :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
 is set to ``true``.

 For more information, see the :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation.

 .. note::

   The message will be missing if the host didn't receive enough traffic to compute a success rate, or if the
   cluster didn't have enough hosts to perform outlier ejection based on success rate.
      .envoy.type.v3.Percent local_origin_success_rate = 8;

    • hasLocality

      boolean hasLocality()
       locality of the host.
      .envoy.config.core.v3.Locality locality = 9;
      Returns:
      Whether the locality field is set.

    • getLocality

      Locality getLocality()
       locality of the host.
      .envoy.config.core.v3.Locality locality = 9;
      Returns:
      The locality.

    • getLocalityOrBuilder

      LocalityOrBuilder getLocalityOrBuilder()
       locality of the host.
      .envoy.config.core.v3.Locality locality = 9;