io.envoyproxy.envoy.admin.v2alpha

Class HostStatus

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.admin.v2alpha.HostStatus

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HostStatusOrBuilder, Serializable

public final class HostStatus
extends com.google.protobuf.GeneratedMessageV3
implements HostStatusOrBuilder

 Current state of a particular host.
 [#next-free-field: 10]
 

Protobuf type envoy.admin.v2alpha.HostStatus

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HostStatus.Builder Current state of a particular host.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADDRESS_FIELD_NUMBER
static int	HEALTH_STATUS_FIELD_NUMBER
static int	HOSTNAME_FIELD_NUMBER
static int	LOCAL_ORIGIN_SUCCESS_RATE_FIELD_NUMBER
static int	LOCALITY_FIELD_NUMBER
static int	PRIORITY_FIELD_NUMBER
static int	STATS_FIELD_NUMBER
static int	SUCCESS_RATE_FIELD_NUMBER
static int	WEIGHT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Address	getAddress() Address of this host.
AddressOrBuilder	getAddressOrBuilder() Address of this host.
static HostStatus	getDefaultInstance()
HostStatus	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
HostHealthStatus	getHealthStatus() The host's current health status.
HostHealthStatusOrBuilder	getHealthStatusOrBuilder() The host's current health status.
String	getHostname() The hostname of the host, if applicable.
com.google.protobuf.ByteString	getHostnameBytes() The hostname of the host, if applicable.
Locality	getLocality() locality of the host.
LocalityOrBuilder	getLocalityOrBuilder() locality of the host.
Percent	getLocalOriginSuccessRate() Request success rate for this host over the last calculated interval when only locally originated errors are taken into account and externally originated errors were treated as success.
PercentOrBuilder	getLocalOriginSuccessRateOrBuilder() Request success rate for this host over the last calculated interval when only locally originated errors are taken into account and externally originated errors were treated as success.
com.google.protobuf.Parser<HostStatus>	getParserForType()
int	getPriority() The host's priority.
int	getSerializedSize()
SimpleMetric	getStats(int index) List of stats specific to this host.
int	getStatsCount() List of stats specific to this host.
List<SimpleMetric>	getStatsList() List of stats specific to this host.
SimpleMetricOrBuilder	getStatsOrBuilder(int index) List of stats specific to this host.
List<? extends SimpleMetricOrBuilder>	getStatsOrBuilderList() List of stats specific to this host.
Percent	getSuccessRate() Request success rate for this host over the last calculated interval.
PercentOrBuilder	getSuccessRateOrBuilder() Request success rate for this host over the last calculated interval.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	getWeight() The host's weight.
boolean	hasAddress() Address of this host.
int	hashCode()
boolean	hasHealthStatus() The host's current health status.
boolean	hasLocality() locality of the host.
boolean	hasLocalOriginSuccessRate() Request success rate for this host over the last calculated interval when only locally originated errors are taken into account and externally originated errors were treated as success.
boolean	hasSuccessRate() Request success rate for this host over the last calculated interval.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static HostStatus.Builder	newBuilder()
static HostStatus.Builder	newBuilder(HostStatus prototype)
HostStatus.Builder	newBuilderForType()
protected HostStatus.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static HostStatus	parseDelimitedFrom(InputStream input)
static HostStatus	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HostStatus	parseFrom(byte[] data)
static HostStatus	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HostStatus	parseFrom(ByteBuffer data)
static HostStatus	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HostStatus	parseFrom(com.google.protobuf.ByteString data)
static HostStatus	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HostStatus	parseFrom(com.google.protobuf.CodedInputStream input)
static HostStatus	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HostStatus	parseFrom(InputStream input)
static HostStatus	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<HostStatus>	parser()
HostStatus.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ADDRESS_FIELD_NUMBER

public static final int ADDRESS_FIELD_NUMBER

See Also:

Constant Field Values

STATS_FIELD_NUMBER

public static final int STATS_FIELD_NUMBER

See Also:

Constant Field Values

HEALTH_STATUS_FIELD_NUMBER

public static final int HEALTH_STATUS_FIELD_NUMBER

See Also:

Constant Field Values

SUCCESS_RATE_FIELD_NUMBER

public static final int SUCCESS_RATE_FIELD_NUMBER

See Also:

Constant Field Values

WEIGHT_FIELD_NUMBER

public static final int WEIGHT_FIELD_NUMBER

See Also:

Constant Field Values

HOSTNAME_FIELD_NUMBER

public static final int HOSTNAME_FIELD_NUMBER

See Also:

Constant Field Values

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER

See Also:

Constant Field Values

LOCAL_ORIGIN_SUCCESS_RATE_FIELD_NUMBER

public static final int LOCAL_ORIGIN_SUCCESS_RATE_FIELD_NUMBER

See Also:

Constant Field Values

LOCALITY_FIELD_NUMBER

public static final int LOCALITY_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

hasAddress

public boolean hasAddress()

 Address of this host.
 

.envoy.api.v2.core.Address address = 1;

Specified by:

hasAddress in interface HostStatusOrBuilder

getAddress

public Address getAddress()

 Address of this host.
 

.envoy.api.v2.core.Address address = 1;

Specified by:

getAddress in interface HostStatusOrBuilder

getAddressOrBuilder

public AddressOrBuilder getAddressOrBuilder()

 Address of this host.
 

.envoy.api.v2.core.Address address = 1;

Specified by:

getAddressOrBuilder in interface HostStatusOrBuilder

getStatsList

public List<SimpleMetric> getStatsList()

 List of stats specific to this host.
 

repeated .envoy.admin.v2alpha.SimpleMetric stats = 2;

Specified by:

getStatsList in interface HostStatusOrBuilder

getStatsOrBuilderList

public List<? extends SimpleMetricOrBuilder> getStatsOrBuilderList()

 List of stats specific to this host.
 

repeated .envoy.admin.v2alpha.SimpleMetric stats = 2;

Specified by:

getStatsOrBuilderList in interface HostStatusOrBuilder

getStatsCount

public int getStatsCount()

 List of stats specific to this host.
 

repeated .envoy.admin.v2alpha.SimpleMetric stats = 2;

Specified by:

getStatsCount in interface HostStatusOrBuilder

getStats

public SimpleMetric getStats(int index)

 List of stats specific to this host.
 

repeated .envoy.admin.v2alpha.SimpleMetric stats = 2;

Specified by:

getStats in interface HostStatusOrBuilder

getStatsOrBuilder

public SimpleMetricOrBuilder getStatsOrBuilder(int index)

 List of stats specific to this host.
 

repeated .envoy.admin.v2alpha.SimpleMetric stats = 2;

Specified by:

getStatsOrBuilder in interface HostStatusOrBuilder

hasHealthStatus

public boolean hasHealthStatus()

 The host's current health status.
 

.envoy.admin.v2alpha.HostHealthStatus health_status = 3;

Specified by:

hasHealthStatus in interface HostStatusOrBuilder

getHealthStatus

public HostHealthStatus getHealthStatus()

 The host's current health status.
 

.envoy.admin.v2alpha.HostHealthStatus health_status = 3;

Specified by:

getHealthStatus in interface HostStatusOrBuilder

getHealthStatusOrBuilder

public HostHealthStatusOrBuilder getHealthStatusOrBuilder()

 The host's current health status.
 

.envoy.admin.v2alpha.HostHealthStatus health_status = 3;

Specified by:

getHealthStatusOrBuilder in interface HostStatusOrBuilder

hasSuccessRate

public boolean hasSuccessRate()

 Request success rate for this host over the last calculated 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 in success rate
 calculation. 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 in success rate calculation.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
 

.envoy.type.Percent success_rate = 4;

Specified by:

hasSuccessRate in interface HostStatusOrBuilder

getSuccessRate

public Percent getSuccessRate()

 Request success rate for this host over the last calculated 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 in success rate
 calculation. 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 in success rate calculation.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
 

.envoy.type.Percent success_rate = 4;

Specified by:

getSuccessRate in interface HostStatusOrBuilder

getSuccessRateOrBuilder

public PercentOrBuilder getSuccessRateOrBuilder()

 Request success rate for this host over the last calculated 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 in success rate
 calculation. 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 in success rate calculation.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
 

.envoy.type.Percent success_rate = 4;

Specified by:

getSuccessRateOrBuilder in interface HostStatusOrBuilder

getWeight

public int getWeight()

 The host's weight. If not configured, the value defaults to 1.
 

uint32 weight = 5;

Specified by:

getWeight in interface HostStatusOrBuilder

getHostname

public String getHostname()

 The hostname of the host, if applicable.
 

string hostname = 6;

Specified by:

getHostname in interface HostStatusOrBuilder

getHostnameBytes

public com.google.protobuf.ByteString getHostnameBytes()

 The hostname of the host, if applicable.
 

string hostname = 6;

Specified by:

getHostnameBytes in interface HostStatusOrBuilder

getPriority

public int getPriority()

 The host's priority. If not configured, the value defaults to 0 (highest priority).
 

uint32 priority = 7;

Specified by:

getPriority in interface HostStatusOrBuilder

hasLocalOriginSuccessRate

public boolean hasLocalOriginSuccessRate()

 Request success rate for this host over the last calculated
 interval when only locally originated errors are 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*.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
 

.envoy.type.Percent local_origin_success_rate = 8;

Specified by:

hasLocalOriginSuccessRate in interface HostStatusOrBuilder

getLocalOriginSuccessRate

public Percent getLocalOriginSuccessRate()

 Request success rate for this host over the last calculated
 interval when only locally originated errors are 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*.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
 

.envoy.type.Percent local_origin_success_rate = 8;

Specified by:

getLocalOriginSuccessRate in interface HostStatusOrBuilder

getLocalOriginSuccessRateOrBuilder

public PercentOrBuilder getLocalOriginSuccessRateOrBuilder()

 Request success rate for this host over the last calculated
 interval when only locally originated errors are 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*.
 See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
 details.
 Note: the message will not be present if host did not have enough request volume to calculate
 success rate or the cluster did not have enough hosts to run through success rate outlier
 ejection.
 

.envoy.type.Percent local_origin_success_rate = 8;

Specified by:

getLocalOriginSuccessRateOrBuilder in interface HostStatusOrBuilder

hasLocality

public boolean hasLocality()

 locality of the host.
 

.envoy.api.v2.core.Locality locality = 9;

Specified by:

hasLocality in interface HostStatusOrBuilder

getLocality

public Locality getLocality()

 locality of the host.
 

.envoy.api.v2.core.Locality locality = 9;

Specified by:

getLocality in interface HostStatusOrBuilder

getLocalityOrBuilder

public LocalityOrBuilder getLocalityOrBuilder()

 locality of the host.
 

.envoy.api.v2.core.Locality locality = 9;

Specified by:

getLocalityOrBuilder in interface HostStatusOrBuilder

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 HostStatus parseFrom(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HostStatus parseFrom(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HostStatus parseFrom(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HostStatus parseFrom(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HostStatus parseFrom(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HostStatus parseFrom(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HostStatus parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static HostStatus parseFrom(InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static HostStatus parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static HostStatus parseDelimitedFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseFrom

public static HostStatus parseFrom(com.google.protobuf.CodedInputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static HostStatus parseFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

newBuilderForType

public HostStatus.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static HostStatus.Builder newBuilder()

newBuilder

public static HostStatus.Builder newBuilder(HostStatus prototype)

toBuilder

public HostStatus.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected HostStatus.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static HostStatus getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<HostStatus> 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 HostStatus getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder