Package io.envoyproxy.envoy.admin.v3

Class ClusterStatus

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClusterStatusOrBuilder, Serializable
    public final class ClusterStatus
extends com.google.protobuf.GeneratedMessageV3
implements ClusterStatusOrBuilder
     Details an individual cluster's current status.
 [#next-free-field: 8]
    Protobuf type envoy.admin.v3.ClusterStatus
    See Also:
    Serialized Form

    • Field Detail

      • ADDED_VIA_API_FIELD_NUMBER

        public static final int ADDED_VIA_API_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUCCESS_RATE_EJECTION_THRESHOLD_FIELD_NUMBER

        public static final int SUCCESS_RATE_EJECTION_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HOST_STATUSES_FIELD_NUMBER

        public static final int HOST_STATUSES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOCAL_ORIGIN_SUCCESS_RATE_EJECTION_THRESHOLD_FIELD_NUMBER

        public static final int LOCAL_ORIGIN_SUCCESS_RATE_EJECTION_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CIRCUIT_BREAKERS_FIELD_NUMBER

        public static final int CIRCUIT_BREAKERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OBSERVABILITY_NAME_FIELD_NUMBER

        public static final int OBSERVABILITY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Name of the cluster.
        string name = 1;
        Specified by:
        getNameBytes in interface ClusterStatusOrBuilder
        Returns:
        The bytes for name.

      • getAddedViaApi

        public boolean getAddedViaApi()
         Denotes whether this cluster was added via API or configured statically.
        bool added_via_api = 2;
        Specified by:
        getAddedViaApi in interface ClusterStatusOrBuilder
        Returns:
        The addedViaApi.

      • hasSuccessRateEjectionThreshold

        public boolean hasSuccessRateEjectionThreshold()
         The success rate threshold used in the last 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 to calculate the threshold.
 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 to calculate the threshold.
 The threshold is used to eject hosts based on their success rate. See
 :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for details.
 Note: this field may be omitted in any of the three following cases:
 1. There were not enough hosts with enough request volume to proceed with success rate based
    outlier ejection.
 2. The threshold is computed to be < 0 because a negative value implies that there was no
    threshold for that interval.
 3. Outlier detection is not enabled for this cluster.
        .envoy.type.v3.Percent success_rate_ejection_threshold = 3;
        Specified by:
        hasSuccessRateEjectionThreshold in interface ClusterStatusOrBuilder
        Returns:
        Whether the successRateEjectionThreshold field is set.

      • getSuccessRateEjectionThreshold

        public Percent getSuccessRateEjectionThreshold()
         The success rate threshold used in the last 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 to calculate the threshold.
 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 to calculate the threshold.
 The threshold is used to eject hosts based on their success rate. See
 :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for details.
 Note: this field may be omitted in any of the three following cases:
 1. There were not enough hosts with enough request volume to proceed with success rate based
    outlier ejection.
 2. The threshold is computed to be < 0 because a negative value implies that there was no
    threshold for that interval.
 3. Outlier detection is not enabled for this cluster.
        .envoy.type.v3.Percent success_rate_ejection_threshold = 3;
        Specified by:
        getSuccessRateEjectionThreshold in interface ClusterStatusOrBuilder
        Returns:
        The successRateEjectionThreshold.

      • getSuccessRateEjectionThresholdOrBuilder

        public PercentOrBuilder getSuccessRateEjectionThresholdOrBuilder()
         The success rate threshold used in the last 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 to calculate the threshold.
 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 to calculate the threshold.
 The threshold is used to eject hosts based on their success rate. See
 :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for details.
 Note: this field may be omitted in any of the three following cases:
 1. There were not enough hosts with enough request volume to proceed with success rate based
    outlier ejection.
 2. The threshold is computed to be < 0 because a negative value implies that there was no
    threshold for that interval.
 3. Outlier detection is not enabled for this cluster.
        .envoy.type.v3.Percent success_rate_ejection_threshold = 3;
        Specified by:
        getSuccessRateEjectionThresholdOrBuilder in interface ClusterStatusOrBuilder

      • getHostStatusesCount

        public int getHostStatusesCount()
         Mapping from host address to the host's current status.
        repeated .envoy.admin.v3.HostStatus host_statuses = 4;
        Specified by:
        getHostStatusesCount in interface ClusterStatusOrBuilder

      • getHostStatuses

        public HostStatus getHostStatuses​(int index)
         Mapping from host address to the host's current status.
        repeated .envoy.admin.v3.HostStatus host_statuses = 4;
        Specified by:
        getHostStatuses in interface ClusterStatusOrBuilder

      • hasLocalOriginSuccessRateEjectionThreshold

        public boolean hasLocalOriginSuccessRateEjectionThreshold()
         The success rate threshold used in the last interval when only locally originated failures were
 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``. The threshold is used to eject hosts based on their success rate.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: this field may be omitted in any of the three following cases:
 1. There were not enough hosts with enough request volume to proceed with success rate based
    outlier ejection.
 2. The threshold is computed to be < 0 because a negative value implies that there was no
    threshold for that interval.
 3. Outlier detection is not enabled for this cluster.
        .envoy.type.v3.Percent local_origin_success_rate_ejection_threshold = 5;
        Specified by:
        hasLocalOriginSuccessRateEjectionThreshold in interface ClusterStatusOrBuilder
        Returns:
        Whether the localOriginSuccessRateEjectionThreshold field is set.

      • getLocalOriginSuccessRateEjectionThreshold

        public Percent getLocalOriginSuccessRateEjectionThreshold()
         The success rate threshold used in the last interval when only locally originated failures were
 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``. The threshold is used to eject hosts based on their success rate.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: this field may be omitted in any of the three following cases:
 1. There were not enough hosts with enough request volume to proceed with success rate based
    outlier ejection.
 2. The threshold is computed to be < 0 because a negative value implies that there was no
    threshold for that interval.
 3. Outlier detection is not enabled for this cluster.
        .envoy.type.v3.Percent local_origin_success_rate_ejection_threshold = 5;
        Specified by:
        getLocalOriginSuccessRateEjectionThreshold in interface ClusterStatusOrBuilder
        Returns:
        The localOriginSuccessRateEjectionThreshold.

      • getLocalOriginSuccessRateEjectionThresholdOrBuilder

        public PercentOrBuilder getLocalOriginSuccessRateEjectionThresholdOrBuilder()
         The success rate threshold used in the last interval when only locally originated failures were
 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``. The threshold is used to eject hosts based on their success rate.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: this field may be omitted in any of the three following cases:
 1. There were not enough hosts with enough request volume to proceed with success rate based
    outlier ejection.
 2. The threshold is computed to be < 0 because a negative value implies that there was no
    threshold for that interval.
 3. Outlier detection is not enabled for this cluster.
        .envoy.type.v3.Percent local_origin_success_rate_ejection_threshold = 5;
        Specified by:
        getLocalOriginSuccessRateEjectionThresholdOrBuilder in interface ClusterStatusOrBuilder

      • hasCircuitBreakers

        public boolean hasCircuitBreakers()
         :ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
        .envoy.config.cluster.v3.CircuitBreakers circuit_breakers = 6;
        Specified by:
        hasCircuitBreakers in interface ClusterStatusOrBuilder
        Returns:
        Whether the circuitBreakers field is set.

      • getCircuitBreakers

        public CircuitBreakers getCircuitBreakers()
         :ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
        .envoy.config.cluster.v3.CircuitBreakers circuit_breakers = 6;
        Specified by:
        getCircuitBreakers in interface ClusterStatusOrBuilder
        Returns:
        The circuitBreakers.

      • getObservabilityNameBytes

        public com.google.protobuf.ByteString getObservabilityNameBytes()
         Observability name of the cluster.
        string observability_name = 7;
        Specified by:
        getObservabilityNameBytes in interface ClusterStatusOrBuilder
        Returns:
        The bytes for observabilityName.

      • 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 ClusterStatus parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static ClusterStatus getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<ClusterStatus> 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 ClusterStatus getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder