// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: envoy/admin/v3/clusters.proto
package io.envoyproxy.envoy.admin.v3;
public interface ClusterStatusOrBuilder extends
// @@protoc_insertion_point(interface_extends:envoy.admin.v3.ClusterStatus)
com.google.protobuf.MessageOrBuilder {
/**
*
* Name of the cluster.
*
*
* string name = 1;
* @return The name.
*/
java.lang.String getName();
/**
*
* Name of the cluster.
*
*
* string name = 1;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* Denotes whether this cluster was added via API or configured statically.
*
*
* bool added_via_api = 2;
* @return The addedViaApi.
*/
boolean getAddedViaApi();
/**
*
* 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;
* @return Whether the successRateEjectionThreshold field is set.
*/
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;
* @return The successRateEjectionThreshold.
*/
io.envoyproxy.envoy.type.v3.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;
*/
io.envoyproxy.envoy.type.v3.PercentOrBuilder getSuccessRateEjectionThresholdOrBuilder();
/**
*
* Mapping from host address to the host's current status.
*
*
* repeated .envoy.admin.v3.HostStatus host_statuses = 4;
*/
java.util.List
getHostStatusesList();
/**
*
* Mapping from host address to the host's current status.
*
*
* repeated .envoy.admin.v3.HostStatus host_statuses = 4;
*/
io.envoyproxy.envoy.admin.v3.HostStatus getHostStatuses(int index);
/**
*
* Mapping from host address to the host's current status.
*
*
* repeated .envoy.admin.v3.HostStatus host_statuses = 4;
*/
int getHostStatusesCount();
/**
*
* Mapping from host address to the host's current status.
*
*
* repeated .envoy.admin.v3.HostStatus host_statuses = 4;
*/
java.util.List
getHostStatusesOrBuilderList();
/**
*
* Mapping from host address to the host's current status.
*
*
* repeated .envoy.admin.v3.HostStatus host_statuses = 4;
*/
io.envoyproxy.envoy.admin.v3.HostStatusOrBuilder getHostStatusesOrBuilder(
int index);
/**
*
* 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;
* @return Whether the localOriginSuccessRateEjectionThreshold field is set.
*/
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;
* @return The localOriginSuccessRateEjectionThreshold.
*/
io.envoyproxy.envoy.type.v3.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;
*/
io.envoyproxy.envoy.type.v3.PercentOrBuilder getLocalOriginSuccessRateEjectionThresholdOrBuilder();
/**
*
* :ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
*
*
* .envoy.config.cluster.v3.CircuitBreakers circuit_breakers = 6;
* @return Whether the circuitBreakers field is set.
*/
boolean hasCircuitBreakers();
/**
*
* :ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
*
*
* .envoy.config.cluster.v3.CircuitBreakers circuit_breakers = 6;
* @return The circuitBreakers.
*/
io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers getCircuitBreakers();
/**
*
* :ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
*
*
* .envoy.config.cluster.v3.CircuitBreakers circuit_breakers = 6;
*/
io.envoyproxy.envoy.config.cluster.v3.CircuitBreakersOrBuilder getCircuitBreakersOrBuilder();
/**
*
* Observability name of the cluster.
*
*
* string observability_name = 7;
* @return The observabilityName.
*/
java.lang.String getObservabilityName();
/**
*
* Observability name of the cluster.
*
*
* string observability_name = 7;
* @return The bytes for observabilityName.
*/
com.google.protobuf.ByteString
getObservabilityNameBytes();
/**
*
* The :ref:`EDS service name <envoy_v3_api_field_config.cluster.v3.Cluster.EdsClusterConfig.service_name>` if the cluster is an EDS cluster.
*
*
* string eds_service_name = 8;
* @return The edsServiceName.
*/
java.lang.String getEdsServiceName();
/**
*
* The :ref:`EDS service name <envoy_v3_api_field_config.cluster.v3.Cluster.EdsClusterConfig.service_name>` if the cluster is an EDS cluster.
*
*
* string eds_service_name = 8;
* @return The bytes for edsServiceName.
*/
com.google.protobuf.ByteString
getEdsServiceNameBytes();
}
