Package io.envoyproxy.envoy.admin.v3

Class 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:
    Serialized Form

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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.

      • 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

      • 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.

      • hasSuccessRate

        public boolean hasSuccessRate()
         Request success rate for this host over the last calculated 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.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
        .envoy.type.v3.Percent success_rate = 4;
        Specified by:
        hasSuccessRate in interface HostStatusOrBuilder
        Returns:
        Whether the successRate field is set.

      • getSuccessRate

        public Percent getSuccessRate()
         Request success rate for this host over the last calculated 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.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
        .envoy.type.v3.Percent success_rate = 4;
        Specified by:
        getSuccessRate in interface HostStatusOrBuilder
        Returns:
        The successRate.

      • getSuccessRateOrBuilder

        public PercentOrBuilder getSuccessRateOrBuilder()
         Request success rate for this host over the last calculated 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.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
        .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()
         Request success rate for this host over the last calculated
 interval when only locally originated errors are taken into account and externally originated
 errors were treated as success.
 This field should be interpreted only when
 :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
 is ``true``.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
        .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()
         Request success rate for this host over the last calculated
 interval when only locally originated errors are taken into account and externally originated
 errors were treated as success.
 This field should be interpreted only when
 :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
 is ``true``.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
        .envoy.type.v3.Percent local_origin_success_rate = 8;
        Specified by:
        getLocalOriginSuccessRate in interface HostStatusOrBuilder
        Returns:
        The localOriginSuccessRate.

      • getLocalOriginSuccessRateOrBuilder

        public PercentOrBuilder getLocalOriginSuccessRateOrBuilder()
         Request success rate for this host over the last calculated
 interval when only locally originated errors are taken into account and externally originated
 errors were treated as success.
 This field should be interpreted only when
 :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
 is ``true``.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
        .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.

      • 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​(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

      • 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