io.envoyproxy.envoy.admin.v2alpha

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 Summary

Modifier and Type	Method and Description
boolean	getAddedViaApi() Denotes whether this cluster was added via API or configured statically.
HostStatus	getHostStatuses(int index) Mapping from host address to the host's current status.
int	getHostStatusesCount() Mapping from host address to the host's current status.
List<HostStatus>	getHostStatusesList() Mapping from host address to the host's current status.
HostStatusOrBuilder	getHostStatusesOrBuilder(int index) Mapping from host address to the host's current status.
List<? extends HostStatusOrBuilder>	getHostStatusesOrBuilderList() Mapping from host address to the host's current status.
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.
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.
String	getName() Name of the cluster.
com.google.protobuf.ByteString	getNameBytes() Name of the cluster.
Percent	getSuccessRateEjectionThreshold() The success rate threshold used in the last interval.
PercentOrBuilder	getSuccessRateEjectionThresholdOrBuilder() The success rate threshold used in the last interval.
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.
boolean	hasSuccessRateEjectionThreshold() The success rate threshold used in the last interval.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Name of the cluster.
 

string name = 1;

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Name of the cluster.
 

string name = 1;

getAddedViaApi

boolean getAddedViaApi()

 Denotes whether this cluster was added via API or configured statically.
 

bool added_via_api = 2;

hasSuccessRateEjectionThreshold

boolean hasSuccessRateEjectionThreshold()

 The success rate threshold used in the last interval.
 If
 :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.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_api_field_cluster.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.Percent success_rate_ejection_threshold = 3;

getSuccessRateEjectionThreshold

Percent getSuccessRateEjectionThreshold()

 The success rate threshold used in the last interval.
 If
 :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.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_api_field_cluster.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.Percent success_rate_ejection_threshold = 3;

getSuccessRateEjectionThresholdOrBuilder

PercentOrBuilder getSuccessRateEjectionThresholdOrBuilder()

 The success rate threshold used in the last interval.
 If
 :ref:`outlier_detection.split_external_local_origin_errors<envoy_api_field_cluster.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_api_field_cluster.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.Percent success_rate_ejection_threshold = 3;

getHostStatusesList

List<HostStatus> getHostStatusesList()

 Mapping from host address to the host's current status.
 

repeated .envoy.admin.v2alpha.HostStatus host_statuses = 4;

getHostStatuses

HostStatus getHostStatuses(int index)

 Mapping from host address to the host's current status.
 

repeated .envoy.admin.v2alpha.HostStatus host_statuses = 4;

getHostStatusesCount

int getHostStatusesCount()

 Mapping from host address to the host's current status.
 

repeated .envoy.admin.v2alpha.HostStatus host_statuses = 4;

getHostStatusesOrBuilderList

List<? extends HostStatusOrBuilder> getHostStatusesOrBuilderList()

 Mapping from host address to the host's current status.
 

repeated .envoy.admin.v2alpha.HostStatus host_statuses = 4;

getHostStatusesOrBuilder

HostStatusOrBuilder getHostStatusesOrBuilder(int index)

 Mapping from host address to the host's current status.
 

repeated .envoy.admin.v2alpha.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_api_field_cluster.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.Percent local_origin_success_rate_ejection_threshold = 5;

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_api_field_cluster.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.Percent local_origin_success_rate_ejection_threshold = 5;

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_api_field_cluster.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.Percent local_origin_success_rate_ejection_threshold = 5;