Package io.envoyproxy.envoy.admin.v3

Class HostStatus

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.admin.v3.HostStatus
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HostStatusOrBuilder, Serializable
public final class HostStatus extends com.google.protobuf.GeneratedMessageV3 implements HostStatusOrBuilder
 Current state of a particular host.
 [#next-free-field: 10]
Protobuf type envoy.admin.v3.HostStatus
See Also:

  • Field Details

    • ADDRESS_FIELD_NUMBER

      public static final int ADDRESS_FIELD_NUMBER
      See Also:

    • STATS_FIELD_NUMBER

      public static final int STATS_FIELD_NUMBER
      See Also:

    • HEALTH_STATUS_FIELD_NUMBER

      public static final int HEALTH_STATUS_FIELD_NUMBER
      See Also:

    • SUCCESS_RATE_FIELD_NUMBER

      public static final int SUCCESS_RATE_FIELD_NUMBER
      See Also:

    • WEIGHT_FIELD_NUMBER

      public static final int WEIGHT_FIELD_NUMBER
      See Also:

    • HOSTNAME_FIELD_NUMBER

      public static final int HOSTNAME_FIELD_NUMBER
      See Also:

    • PRIORITY_FIELD_NUMBER

      public static final int PRIORITY_FIELD_NUMBER
      See Also:

    • LOCAL_ORIGIN_SUCCESS_RATE_FIELD_NUMBER

      public static final int LOCAL_ORIGIN_SUCCESS_RATE_FIELD_NUMBER
      See Also:

    • LOCALITY_FIELD_NUMBER

      public static final int LOCALITY_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasAddress

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

    • getAddress

      public Address getAddress()
       Address of this host.
      .envoy.config.core.v3.Address address = 1;
      Specified by:
      getAddress in interface HostStatusOrBuilder
      Returns:
      The address.

    • getAddressOrBuilder

      public AddressOrBuilder getAddressOrBuilder()
       Address of this host.
      .envoy.config.core.v3.Address address = 1;
      Specified by:
      getAddressOrBuilder in interface HostStatusOrBuilder

    • getStatsList

      public List<SimpleMetric> getStatsList()
       List of stats specific to this host.
      repeated .envoy.admin.v3.SimpleMetric stats = 2;
      Specified by:
      getStatsList in interface HostStatusOrBuilder

    • getStatsOrBuilderList

      public List<? extends SimpleMetricOrBuilder> getStatsOrBuilderList()
       List of stats specific to this host.
      repeated .envoy.admin.v3.SimpleMetric stats = 2;
      Specified by:
      getStatsOrBuilderList in interface HostStatusOrBuilder

    • getStatsCount

      public int getStatsCount()
       List of stats specific to this host.
      repeated .envoy.admin.v3.SimpleMetric stats = 2;
      Specified by:
      getStatsCount in interface HostStatusOrBuilder

    • getStats

      public SimpleMetric getStats(int index)
       List of stats specific to this host.
      repeated .envoy.admin.v3.SimpleMetric stats = 2;
      Specified by:
      getStats in interface HostStatusOrBuilder

    • getStatsOrBuilder

      public SimpleMetricOrBuilder getStatsOrBuilder(int index)
       List of stats specific to this host.
      repeated .envoy.admin.v3.SimpleMetric stats = 2;
      Specified by:
      getStatsOrBuilder in interface HostStatusOrBuilder

    • hasHealthStatus

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

    • getHealthStatus

      public HostHealthStatus getHealthStatus()
       The host's current health status.
      .envoy.admin.v3.HostHealthStatus health_status = 3;
      Specified by:
      getHealthStatus in interface HostStatusOrBuilder
      Returns:
      The healthStatus.

    • getHealthStatusOrBuilder

      public HostHealthStatusOrBuilder getHealthStatusOrBuilder()
       The host's current health status.
      .envoy.admin.v3.HostHealthStatus health_status = 3;
      Specified by:
      getHealthStatusOrBuilder in interface HostStatusOrBuilder

    • hasSuccessRate

      public 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;
      Specified by:
      hasSuccessRate in interface HostStatusOrBuilder
      Returns:
      Whether the successRate field is set.

    • getSuccessRate

      public 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;
      Specified by:
      getSuccessRate in interface HostStatusOrBuilder
      Returns:
      The successRate.

    • getSuccessRateOrBuilder

      public 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;
      Specified by:
      getSuccessRateOrBuilder in interface HostStatusOrBuilder

    • getWeight

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

    • getHostname

      public String getHostname()
       The hostname of the host, if applicable.
      string hostname = 6;
      Specified by:
      getHostname in interface HostStatusOrBuilder
      Returns:
      The hostname.

    • getHostnameBytes

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

    • getPriority

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

    • hasLocalOriginSuccessRate

      public 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;
      Specified by:
      hasLocalOriginSuccessRate in interface HostStatusOrBuilder
      Returns:
      Whether the localOriginSuccessRate field is set.

    • getLocalOriginSuccessRate

      public 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;
      Specified by:
      getLocalOriginSuccessRate in interface HostStatusOrBuilder
      Returns:
      The localOriginSuccessRate.

    • getLocalOriginSuccessRateOrBuilder

      public 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;
      Specified by:
      getLocalOriginSuccessRateOrBuilder in interface HostStatusOrBuilder

    • hasLocality

      public boolean hasLocality()
       locality of the host.
      .envoy.config.core.v3.Locality locality = 9;
      Specified by:
      hasLocality in interface HostStatusOrBuilder
      Returns:
      Whether the locality field is set.

    • getLocality

      public Locality getLocality()
       locality of the host.
      .envoy.config.core.v3.Locality locality = 9;
      Specified by:
      getLocality in interface HostStatusOrBuilder
      Returns:
      The locality.

    • getLocalityOrBuilder

      public LocalityOrBuilder getLocalityOrBuilder()
       locality of the host.
      .envoy.config.core.v3.Locality locality = 9;
      Specified by:
      getLocalityOrBuilder in interface HostStatusOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static HostStatus parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HostStatus parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HostStatus parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HostStatus parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HostStatus parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HostStatus parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HostStatus parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HostStatus parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HostStatus parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HostStatus parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HostStatus parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HostStatus parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public HostStatus.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static HostStatus.Builder newBuilder()

    • newBuilder

      public static HostStatus.Builder newBuilder(HostStatus prototype)

    • toBuilder

      public HostStatus.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected HostStatus.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static HostStatus getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<HostStatus> parser()

    • getParserForType

      public com.google.protobuf.Parser<HostStatus> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public HostStatus getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder