envoy.api.v2.endpoint

Class LoadReport.ClusterStats

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

envoy.api.v2.endpoint.LoadReport.ClusterStats

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LoadReport.ClusterStatsOrBuilder, Serializable

Enclosing class:

LoadReport

public static final class LoadReport.ClusterStats
extends com.google.protobuf.GeneratedMessageV3
implements LoadReport.ClusterStatsOrBuilder

 Per cluster load stats. Envoy reports these stats a management server in a
 :ref:`LoadStatsRequest<envoy_api_msg_load_stats.LoadStatsRequest>`
 [#not-implemented-hide:] Not configuration. TBD how to doc proto APIs.
 

Protobuf type envoy.api.v2.endpoint.ClusterStats

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoadReport.ClusterStats.Builder Per cluster load stats.
static class	LoadReport.ClusterStats.DroppedRequests Protobuf type envoy.api.v2.endpoint.ClusterStats.DroppedRequests
static interface	LoadReport.ClusterStats.DroppedRequestsOrBuilder

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLUSTER_NAME_FIELD_NUMBER
static int	DROPPED_REQUESTS_FIELD_NUMBER
static int	LOAD_REPORT_INTERVAL_FIELD_NUMBER
static int	TOTAL_DROPPED_REQUESTS_FIELD_NUMBER
static int	UPSTREAM_LOCALITY_STATS_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)
String	getClusterName() The name of the cluster.
com.google.protobuf.ByteString	getClusterNameBytes() The name of the cluster.
static LoadReport.ClusterStats	getDefaultInstance()
LoadReport.ClusterStats	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
LoadReport.ClusterStats.DroppedRequests	getDroppedRequests(int index) Information about deliberately dropped requests for each category specified in the DropOverload policy.
int	getDroppedRequestsCount() Information about deliberately dropped requests for each category specified in the DropOverload policy.
List<LoadReport.ClusterStats.DroppedRequests>	getDroppedRequestsList() Information about deliberately dropped requests for each category specified in the DropOverload policy.
LoadReport.ClusterStats.DroppedRequestsOrBuilder	getDroppedRequestsOrBuilder(int index) Information about deliberately dropped requests for each category specified in the DropOverload policy.
List<? extends LoadReport.ClusterStats.DroppedRequestsOrBuilder>	getDroppedRequestsOrBuilderList() Information about deliberately dropped requests for each category specified in the DropOverload policy.
com.google.protobuf.Duration	getLoadReportInterval() Period over which the actual load report occurred.
com.google.protobuf.DurationOrBuilder	getLoadReportIntervalOrBuilder() Period over which the actual load report occurred.
com.google.protobuf.Parser<LoadReport.ClusterStats>	getParserForType()
int	getSerializedSize()
long	getTotalDroppedRequests() Cluster-level stats such as total_successful_requests may be computed by summing upstream_locality_stats.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
LoadReport.UpstreamLocalityStats	getUpstreamLocalityStats(int index) Need at least one.
int	getUpstreamLocalityStatsCount() Need at least one.
List<LoadReport.UpstreamLocalityStats>	getUpstreamLocalityStatsList() Need at least one.
LoadReport.UpstreamLocalityStatsOrBuilder	getUpstreamLocalityStatsOrBuilder(int index) Need at least one.
List<? extends LoadReport.UpstreamLocalityStatsOrBuilder>	getUpstreamLocalityStatsOrBuilderList() Need at least one.
int	hashCode()
boolean	hasLoadReportInterval() Period over which the actual load report occurred.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LoadReport.ClusterStats.Builder	newBuilder()
static LoadReport.ClusterStats.Builder	newBuilder(LoadReport.ClusterStats prototype)
LoadReport.ClusterStats.Builder	newBuilderForType()
protected LoadReport.ClusterStats.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static LoadReport.ClusterStats	parseDelimitedFrom(InputStream input)
static LoadReport.ClusterStats	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadReport.ClusterStats	parseFrom(byte[] data)
static LoadReport.ClusterStats	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadReport.ClusterStats	parseFrom(ByteBuffer data)
static LoadReport.ClusterStats	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadReport.ClusterStats	parseFrom(com.google.protobuf.ByteString data)
static LoadReport.ClusterStats	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadReport.ClusterStats	parseFrom(com.google.protobuf.CodedInputStream input)
static LoadReport.ClusterStats	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadReport.ClusterStats	parseFrom(InputStream input)
static LoadReport.ClusterStats	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LoadReport.ClusterStats>	parser()
LoadReport.ClusterStats.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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

CLUSTER_NAME_FIELD_NUMBER

public static final int CLUSTER_NAME_FIELD_NUMBER

See Also:

Constant Field Values

UPSTREAM_LOCALITY_STATS_FIELD_NUMBER

public static final int UPSTREAM_LOCALITY_STATS_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_DROPPED_REQUESTS_FIELD_NUMBER

public static final int TOTAL_DROPPED_REQUESTS_FIELD_NUMBER

See Also:

Constant Field Values

DROPPED_REQUESTS_FIELD_NUMBER

public static final int DROPPED_REQUESTS_FIELD_NUMBER

See Also:

Constant Field Values

LOAD_REPORT_INTERVAL_FIELD_NUMBER

public static final int LOAD_REPORT_INTERVAL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

getClusterName

public String getClusterName()

 The name of the cluster.
 

string cluster_name = 1 [(.validate.rules) = { ... }

Specified by:

getClusterName in interface LoadReport.ClusterStatsOrBuilder

getClusterNameBytes

public com.google.protobuf.ByteString getClusterNameBytes()

 The name of the cluster.
 

string cluster_name = 1 [(.validate.rules) = { ... }

Specified by:

getClusterNameBytes in interface LoadReport.ClusterStatsOrBuilder

getUpstreamLocalityStatsList

public List<LoadReport.UpstreamLocalityStats> getUpstreamLocalityStatsList()

 Need at least one.
 

repeated .envoy.api.v2.endpoint.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }

Specified by:

getUpstreamLocalityStatsList in interface LoadReport.ClusterStatsOrBuilder

getUpstreamLocalityStatsOrBuilderList

public List<? extends LoadReport.UpstreamLocalityStatsOrBuilder> getUpstreamLocalityStatsOrBuilderList()

 Need at least one.
 

repeated .envoy.api.v2.endpoint.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }

Specified by:

getUpstreamLocalityStatsOrBuilderList in interface LoadReport.ClusterStatsOrBuilder

getUpstreamLocalityStatsCount

public int getUpstreamLocalityStatsCount()

 Need at least one.
 

repeated .envoy.api.v2.endpoint.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }

Specified by:

getUpstreamLocalityStatsCount in interface LoadReport.ClusterStatsOrBuilder

getUpstreamLocalityStats

public LoadReport.UpstreamLocalityStats getUpstreamLocalityStats(int index)

 Need at least one.
 

repeated .envoy.api.v2.endpoint.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }

Specified by:

getUpstreamLocalityStats in interface LoadReport.ClusterStatsOrBuilder

getUpstreamLocalityStatsOrBuilder

public LoadReport.UpstreamLocalityStatsOrBuilder getUpstreamLocalityStatsOrBuilder(int index)

 Need at least one.
 

repeated .envoy.api.v2.endpoint.UpstreamLocalityStats upstream_locality_stats = 2 [(.validate.rules) = { ... }

Specified by:

getUpstreamLocalityStatsOrBuilder in interface LoadReport.ClusterStatsOrBuilder

getTotalDroppedRequests

public long getTotalDroppedRequests()

 Cluster-level stats such as total_successful_requests may be computed by
 summing upstream_locality_stats. In addition, below there are additional
 cluster-wide stats. The following total_requests equality holds at the
 cluster-level:
 .. code-block:: none
   sum_locality(total_successful_requests) + sum_locality(total_requests_in_progress) +
     sum_locality(total_error_requests) + total_dropped_requests`
 The total number of dropped requests. This covers requests
 deliberately dropped by the drop_overload policy and circuit breaking.
 

uint64 total_dropped_requests = 3;

Specified by:

getTotalDroppedRequests in interface LoadReport.ClusterStatsOrBuilder

getDroppedRequestsList

public List<LoadReport.ClusterStats.DroppedRequests> getDroppedRequestsList()

 Information about deliberately dropped requests for each category specified
 in the DropOverload policy.
 

repeated .envoy.api.v2.endpoint.ClusterStats.DroppedRequests dropped_requests = 5;

Specified by:

getDroppedRequestsList in interface LoadReport.ClusterStatsOrBuilder

getDroppedRequestsOrBuilderList

public List<? extends LoadReport.ClusterStats.DroppedRequestsOrBuilder> getDroppedRequestsOrBuilderList()

 Information about deliberately dropped requests for each category specified
 in the DropOverload policy.
 

repeated .envoy.api.v2.endpoint.ClusterStats.DroppedRequests dropped_requests = 5;

Specified by:

getDroppedRequestsOrBuilderList in interface LoadReport.ClusterStatsOrBuilder

getDroppedRequestsCount

public int getDroppedRequestsCount()

 Information about deliberately dropped requests for each category specified
 in the DropOverload policy.
 

repeated .envoy.api.v2.endpoint.ClusterStats.DroppedRequests dropped_requests = 5;

Specified by:

getDroppedRequestsCount in interface LoadReport.ClusterStatsOrBuilder

getDroppedRequests

public LoadReport.ClusterStats.DroppedRequests getDroppedRequests(int index)

 Information about deliberately dropped requests for each category specified
 in the DropOverload policy.
 

repeated .envoy.api.v2.endpoint.ClusterStats.DroppedRequests dropped_requests = 5;

Specified by:

getDroppedRequests in interface LoadReport.ClusterStatsOrBuilder

getDroppedRequestsOrBuilder

public LoadReport.ClusterStats.DroppedRequestsOrBuilder getDroppedRequestsOrBuilder(int index)

 Information about deliberately dropped requests for each category specified
 in the DropOverload policy.
 

repeated .envoy.api.v2.endpoint.ClusterStats.DroppedRequests dropped_requests = 5;

Specified by:

getDroppedRequestsOrBuilder in interface LoadReport.ClusterStatsOrBuilder

hasLoadReportInterval

public boolean hasLoadReportInterval()

 Period over which the actual load report occurred. This will be guaranteed to include every
 request reported. Due to system load and delays between the *LoadStatsRequest* sent from Envoy
 and the *LoadStatsResponse* message sent from the management server, this may be longer than
 the requested load reporting interval in the *LoadStatsResponse*.
 

.google.protobuf.Duration load_report_interval = 4;

Specified by:

hasLoadReportInterval in interface LoadReport.ClusterStatsOrBuilder

getLoadReportInterval

public com.google.protobuf.Duration getLoadReportInterval()

 Period over which the actual load report occurred. This will be guaranteed to include every
 request reported. Due to system load and delays between the *LoadStatsRequest* sent from Envoy
 and the *LoadStatsResponse* message sent from the management server, this may be longer than
 the requested load reporting interval in the *LoadStatsResponse*.
 

.google.protobuf.Duration load_report_interval = 4;

Specified by:

getLoadReportInterval in interface LoadReport.ClusterStatsOrBuilder

getLoadReportIntervalOrBuilder

public com.google.protobuf.DurationOrBuilder getLoadReportIntervalOrBuilder()

 Period over which the actual load report occurred. This will be guaranteed to include every
 request reported. Due to system load and delays between the *LoadStatsRequest* sent from Envoy
 and the *LoadStatsResponse* message sent from the management server, this may be longer than
 the requested load reporting interval in the *LoadStatsResponse*.
 

.google.protobuf.Duration load_report_interval = 4;

Specified by:

getLoadReportIntervalOrBuilder in interface LoadReport.ClusterStatsOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LoadReport.ClusterStats parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static LoadReport.ClusterStats parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public LoadReport.ClusterStats.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LoadReport.ClusterStats.Builder newBuilder()

newBuilder

public static LoadReport.ClusterStats.Builder newBuilder(LoadReport.ClusterStats prototype)

toBuilder

public LoadReport.ClusterStats.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LoadReport.ClusterStats getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder