public final class ClusterStatus extends com.google.protobuf.GeneratedMessageV3 implements ClusterStatusOrBuilder
Details an individual cluster's current status. [#next-free-field: 7]Protobuf type
envoy.admin.v3.ClusterStatus| Modifier and Type | Class and Description |
|---|---|
static class |
ClusterStatus.Builder
Details an individual cluster's current status.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ADDED_VIA_API_FIELD_NUMBER |
static int |
CIRCUIT_BREAKERS_FIELD_NUMBER |
static int |
HOST_STATUSES_FIELD_NUMBER |
static int |
LOCAL_ORIGIN_SUCCESS_RATE_EJECTION_THRESHOLD_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
SUCCESS_RATE_EJECTION_THRESHOLD_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
boolean |
getAddedViaApi()
Denotes whether this cluster was added via API or configured statically.
|
CircuitBreakers |
getCircuitBreakers()
:ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
|
CircuitBreakersOrBuilder |
getCircuitBreakersOrBuilder()
:ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
|
static ClusterStatus |
getDefaultInstance() |
ClusterStatus |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<ClusterStatus> |
getParserForType() |
int |
getSerializedSize() |
Percent |
getSuccessRateEjectionThreshold()
The success rate threshold used in the last interval.
|
PercentOrBuilder |
getSuccessRateEjectionThresholdOrBuilder()
The success rate threshold used in the last interval.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasCircuitBreakers()
:ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
|
int |
hashCode() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ClusterStatus.Builder |
newBuilder() |
static ClusterStatus.Builder |
newBuilder(ClusterStatus prototype) |
ClusterStatus.Builder |
newBuilderForType() |
protected ClusterStatus.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ClusterStatus |
parseDelimitedFrom(InputStream input) |
static ClusterStatus |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClusterStatus |
parseFrom(byte[] data) |
static ClusterStatus |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClusterStatus |
parseFrom(ByteBuffer data) |
static ClusterStatus |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClusterStatus |
parseFrom(com.google.protobuf.ByteString data) |
static ClusterStatus |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClusterStatus |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ClusterStatus |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ClusterStatus |
parseFrom(InputStream input) |
static ClusterStatus |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ClusterStatus> |
parser() |
ClusterStatus.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int ADDED_VIA_API_FIELD_NUMBER
public static final int SUCCESS_RATE_EJECTION_THRESHOLD_FIELD_NUMBER
public static final int HOST_STATUSES_FIELD_NUMBER
public static final int LOCAL_ORIGIN_SUCCESS_RATE_EJECTION_THRESHOLD_FIELD_NUMBER
public static final int CIRCUIT_BREAKERS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Name of the cluster.
string name = 1;getName in interface ClusterStatusOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Name of the cluster.
string name = 1;getNameBytes in interface ClusterStatusOrBuilderpublic boolean getAddedViaApi()
Denotes whether this cluster was added via API or configured statically.
bool added_via_api = 2;getAddedViaApi in interface ClusterStatusOrBuilderpublic boolean hasSuccessRateEjectionThreshold()
The success rate threshold used in the last interval.
If
:ref:`outlier_detection.split_external_local_origin_errors<envoy_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_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;hasSuccessRateEjectionThreshold in interface ClusterStatusOrBuilderpublic Percent getSuccessRateEjectionThreshold()
The success rate threshold used in the last interval.
If
:ref:`outlier_detection.split_external_local_origin_errors<envoy_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_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;getSuccessRateEjectionThreshold in interface ClusterStatusOrBuilderpublic PercentOrBuilder getSuccessRateEjectionThresholdOrBuilder()
The success rate threshold used in the last interval.
If
:ref:`outlier_detection.split_external_local_origin_errors<envoy_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_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;getSuccessRateEjectionThresholdOrBuilder in interface ClusterStatusOrBuilderpublic List<HostStatus> getHostStatusesList()
Mapping from host address to the host's current status.
repeated .envoy.admin.v3.HostStatus host_statuses = 4;getHostStatusesList in interface ClusterStatusOrBuilderpublic List<? extends HostStatusOrBuilder> getHostStatusesOrBuilderList()
Mapping from host address to the host's current status.
repeated .envoy.admin.v3.HostStatus host_statuses = 4;getHostStatusesOrBuilderList in interface ClusterStatusOrBuilderpublic int getHostStatusesCount()
Mapping from host address to the host's current status.
repeated .envoy.admin.v3.HostStatus host_statuses = 4;getHostStatusesCount in interface ClusterStatusOrBuilderpublic HostStatus getHostStatuses(int index)
Mapping from host address to the host's current status.
repeated .envoy.admin.v3.HostStatus host_statuses = 4;getHostStatuses in interface ClusterStatusOrBuilderpublic HostStatusOrBuilder getHostStatusesOrBuilder(int index)
Mapping from host address to the host's current status.
repeated .envoy.admin.v3.HostStatus host_statuses = 4;getHostStatusesOrBuilder in interface ClusterStatusOrBuilderpublic 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_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;hasLocalOriginSuccessRateEjectionThreshold in interface ClusterStatusOrBuilderpublic 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_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;getLocalOriginSuccessRateEjectionThreshold in interface ClusterStatusOrBuilderpublic 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_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;getLocalOriginSuccessRateEjectionThresholdOrBuilder in interface ClusterStatusOrBuilderpublic boolean hasCircuitBreakers()
:ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
.envoy.config.cluster.v3.CircuitBreakers circuit_breakers = 6;hasCircuitBreakers in interface ClusterStatusOrBuilderpublic CircuitBreakers getCircuitBreakers()
:ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
.envoy.config.cluster.v3.CircuitBreakers circuit_breakers = 6;getCircuitBreakers in interface ClusterStatusOrBuilderpublic CircuitBreakersOrBuilder getCircuitBreakersOrBuilder()
:ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
.envoy.config.cluster.v3.CircuitBreakers circuit_breakers = 6;getCircuitBreakersOrBuilder in interface ClusterStatusOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ClusterStatus parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterStatus parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterStatus parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterStatus parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterStatus parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterStatus parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ClusterStatus parseFrom(InputStream input) throws IOException
IOExceptionpublic static ClusterStatus parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ClusterStatus parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ClusterStatus parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ClusterStatus parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ClusterStatus parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ClusterStatus.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ClusterStatus.Builder newBuilder()
public static ClusterStatus.Builder newBuilder(ClusterStatus prototype)
public ClusterStatus.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ClusterStatus.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ClusterStatus getDefaultInstance()
public static com.google.protobuf.Parser<ClusterStatus> parser()
public com.google.protobuf.Parser<ClusterStatus> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ClusterStatus getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.