Package io.envoyproxy.envoy.admin.v3

Interface ClusterStatusOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ClusterStatus, ClusterStatus.Builder
    public interface ClusterStatusOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Name of the cluster.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Name of the cluster.
        string name = 1;
        Returns:
        The bytes for name.

      • getAddedViaApi

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

      • hasSuccessRateEjectionThreshold

        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;
        Returns:
        Whether the successRateEjectionThreshold field is set.

      • getSuccessRateEjectionThreshold

        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;
        Returns:
        The successRateEjectionThreshold.

      • getSuccessRateEjectionThresholdOrBuilder

        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;

      • getHostStatusesList

        List<HostStatus> getHostStatusesList()
         Mapping from host address to the host's current status.
        repeated .envoy.admin.v3.HostStatus host_statuses = 4;

      • getHostStatuses

        HostStatus getHostStatuses​(int index)
         Mapping from host address to the host's current status.
        repeated .envoy.admin.v3.HostStatus host_statuses = 4;

      • getHostStatusesCount

        int getHostStatusesCount()
         Mapping from host address to the host's current status.
        repeated .envoy.admin.v3.HostStatus host_statuses = 4;

      • getHostStatusesOrBuilderList

        List<? extends HostStatusOrBuilder> getHostStatusesOrBuilderList()
         Mapping from host address to the host's current status.
        repeated .envoy.admin.v3.HostStatus host_statuses = 4;

      • getHostStatusesOrBuilder

        HostStatusOrBuilder getHostStatusesOrBuilder​(int index)
         Mapping from host address to the host's current status.
        repeated .envoy.admin.v3.HostStatus host_statuses = 4;

      • hasLocalOriginSuccessRateEjectionThreshold

        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;
        Returns:
        Whether the localOriginSuccessRateEjectionThreshold field is set.

      • getLocalOriginSuccessRateEjectionThreshold

        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;
        Returns:
        The localOriginSuccessRateEjectionThreshold.

      • getLocalOriginSuccessRateEjectionThresholdOrBuilder

        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;

      • hasCircuitBreakers

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

      • getCircuitBreakers

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

      • getCircuitBreakersOrBuilder

        CircuitBreakersOrBuilder getCircuitBreakersOrBuilder()
         :ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
        .envoy.config.cluster.v3.CircuitBreakers circuit_breakers = 6;

      • getObservabilityName

        String getObservabilityName()
         Observability name of the cluster.
        string observability_name = 7;
        Returns:
        The observabilityName.

      • getObservabilityNameBytes

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