envoy.api.v2.endpoint

Class LoadReport.UpstreamLocalityStats

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

envoy.api.v2.endpoint.LoadReport.UpstreamLocalityStats

All Implemented Interfaces:

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

Enclosing class:

LoadReport

public static final class LoadReport.UpstreamLocalityStats
extends com.google.protobuf.GeneratedMessageV3
implements LoadReport.UpstreamLocalityStatsOrBuilder

 These are stats Envoy reports to GLB every so often. Report frequency is
 defined by
 :ref:`LoadStatsResponse.load_reporting_interval<envoy_api_field_load_stats.LoadStatsResponse.load_reporting_interval>`.
 Stats per upstream region/zone and optionally per subzone.
 [#not-implemented-hide:] Not configuration. TBD how to doc proto APIs.
 

Protobuf type envoy.api.v2.endpoint.UpstreamLocalityStats

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoadReport.UpstreamLocalityStats.Builder These are stats Envoy reports to GLB every so often.

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	LOAD_METRIC_STATS_FIELD_NUMBER
static int	LOCALITY_FIELD_NUMBER
static int	PRIORITY_FIELD_NUMBER
static int	TOTAL_ERROR_REQUESTS_FIELD_NUMBER
static int	TOTAL_REQUESTS_IN_PROGRESS_FIELD_NUMBER
static int	TOTAL_SUCCESSFUL_REQUESTS_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)
static LoadReport.UpstreamLocalityStats	getDefaultInstance()
LoadReport.UpstreamLocalityStats	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
LoadReport.EndpointLoadMetricStats	getLoadMetricStats(int index) Stats for multi-dimensional load balancing.
int	getLoadMetricStatsCount() Stats for multi-dimensional load balancing.
List<LoadReport.EndpointLoadMetricStats>	getLoadMetricStatsList() Stats for multi-dimensional load balancing.
LoadReport.EndpointLoadMetricStatsOrBuilder	getLoadMetricStatsOrBuilder(int index) Stats for multi-dimensional load balancing.
List<? extends LoadReport.EndpointLoadMetricStatsOrBuilder>	getLoadMetricStatsOrBuilderList() Stats for multi-dimensional load balancing.
Base.Locality	getLocality() Name of zone, region and optionally endpoint group these metrics were collected from.
Base.LocalityOrBuilder	getLocalityOrBuilder() Name of zone, region and optionally endpoint group these metrics were collected from.
com.google.protobuf.Parser<LoadReport.UpstreamLocalityStats>	getParserForType()
int	getPriority() [#not-implemented-hide:] The priority of the endpoint group these metrics were collected from.
int	getSerializedSize()
long	getTotalErrorRequests() The total number of requests that failed due to errors at the endpoint.
long	getTotalRequestsInProgress() The total number of unfinished requests uint64 total_requests_in_progress = 3;
long	getTotalSuccessfulRequests() The total number of requests sent by this Envoy since the last report.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasLocality() Name of zone, region and optionally endpoint group these metrics were collected from.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LoadReport.UpstreamLocalityStats.Builder	newBuilder()
static LoadReport.UpstreamLocalityStats.Builder	newBuilder(LoadReport.UpstreamLocalityStats prototype)
LoadReport.UpstreamLocalityStats.Builder	newBuilderForType()
protected LoadReport.UpstreamLocalityStats.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static LoadReport.UpstreamLocalityStats	parseDelimitedFrom(InputStream input)
static LoadReport.UpstreamLocalityStats	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadReport.UpstreamLocalityStats	parseFrom(byte[] data)
static LoadReport.UpstreamLocalityStats	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadReport.UpstreamLocalityStats	parseFrom(ByteBuffer data)
static LoadReport.UpstreamLocalityStats	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadReport.UpstreamLocalityStats	parseFrom(com.google.protobuf.ByteString data)
static LoadReport.UpstreamLocalityStats	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadReport.UpstreamLocalityStats	parseFrom(com.google.protobuf.CodedInputStream input)
static LoadReport.UpstreamLocalityStats	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LoadReport.UpstreamLocalityStats	parseFrom(InputStream input)
static LoadReport.UpstreamLocalityStats	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LoadReport.UpstreamLocalityStats>	parser()
LoadReport.UpstreamLocalityStats.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

LOCALITY_FIELD_NUMBER

public static final int LOCALITY_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_SUCCESSFUL_REQUESTS_FIELD_NUMBER

public static final int TOTAL_SUCCESSFUL_REQUESTS_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_REQUESTS_IN_PROGRESS_FIELD_NUMBER

public static final int TOTAL_REQUESTS_IN_PROGRESS_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_ERROR_REQUESTS_FIELD_NUMBER

public static final int TOTAL_ERROR_REQUESTS_FIELD_NUMBER

See Also:

Constant Field Values

LOAD_METRIC_STATS_FIELD_NUMBER

public static final int LOAD_METRIC_STATS_FIELD_NUMBER

See Also:

Constant Field Values

PRIORITY_FIELD_NUMBER

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

hasLocality

public boolean hasLocality()

 Name of zone, region and optionally endpoint group these metrics were
 collected from. Zone and region names could be empty if unknown.
 

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

Specified by:

hasLocality in interface LoadReport.UpstreamLocalityStatsOrBuilder

getLocality

public Base.Locality getLocality()

 Name of zone, region and optionally endpoint group these metrics were
 collected from. Zone and region names could be empty if unknown.
 

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

Specified by:

getLocality in interface LoadReport.UpstreamLocalityStatsOrBuilder

getLocalityOrBuilder

public Base.LocalityOrBuilder getLocalityOrBuilder()

 Name of zone, region and optionally endpoint group these metrics were
 collected from. Zone and region names could be empty if unknown.
 

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

Specified by:

getLocalityOrBuilder in interface LoadReport.UpstreamLocalityStatsOrBuilder

getTotalSuccessfulRequests

public long getTotalSuccessfulRequests()

 The total number of requests sent by this Envoy since the last report. A
 single HTTP or gRPC request or stream is counted as one request. A TCP
 connection is also treated as one request. There is no explicit
 total_requests field below for a locality, but it may be inferred from:
 .. code-block:: none
   total_requests = total_successful_requests + total_requests_in_progress +
     total_error_requests
 The total number of requests successfully completed by the endpoints in the
 locality. These include non-5xx responses for HTTP, where errors
 originate at the client and the endpoint responded successfully. For gRPC,
 the grpc-status values are those not covered by total_error_requests below.
 

uint64 total_successful_requests = 2;

Specified by:

getTotalSuccessfulRequests in interface LoadReport.UpstreamLocalityStatsOrBuilder

getTotalRequestsInProgress

public long getTotalRequestsInProgress()

 The total number of unfinished requests
 

uint64 total_requests_in_progress = 3;

Specified by:

getTotalRequestsInProgress in interface LoadReport.UpstreamLocalityStatsOrBuilder

getTotalErrorRequests

public long getTotalErrorRequests()

 The total number of requests that failed due to errors at the endpoint.
 For HTTP these are responses with 5xx status codes and for gRPC the
 grpc-status values:
   - DeadlineExceeded
   - Unimplemented
   - Internal
   - Unavailable
   - Unknown
   - DataLoss
 

uint64 total_error_requests = 4;

Specified by:

getTotalErrorRequests in interface LoadReport.UpstreamLocalityStatsOrBuilder

getLoadMetricStatsList

public List<LoadReport.EndpointLoadMetricStats> getLoadMetricStatsList()

 Stats for multi-dimensional load balancing.
 

repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

Specified by:

getLoadMetricStatsList in interface LoadReport.UpstreamLocalityStatsOrBuilder

getLoadMetricStatsOrBuilderList

public List<? extends LoadReport.EndpointLoadMetricStatsOrBuilder> getLoadMetricStatsOrBuilderList()

 Stats for multi-dimensional load balancing.
 

repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

Specified by:

getLoadMetricStatsOrBuilderList in interface LoadReport.UpstreamLocalityStatsOrBuilder

getLoadMetricStatsCount

public int getLoadMetricStatsCount()

 Stats for multi-dimensional load balancing.
 

repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

Specified by:

getLoadMetricStatsCount in interface LoadReport.UpstreamLocalityStatsOrBuilder

getLoadMetricStats

public LoadReport.EndpointLoadMetricStats getLoadMetricStats(int index)

 Stats for multi-dimensional load balancing.
 

repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

Specified by:

getLoadMetricStats in interface LoadReport.UpstreamLocalityStatsOrBuilder

getLoadMetricStatsOrBuilder

public LoadReport.EndpointLoadMetricStatsOrBuilder getLoadMetricStatsOrBuilder(int index)

 Stats for multi-dimensional load balancing.
 

repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

Specified by:

getLoadMetricStatsOrBuilder in interface LoadReport.UpstreamLocalityStatsOrBuilder

getPriority

public int getPriority()

 [#not-implemented-hide:] The priority of the endpoint group these metrics
 were collected from.
 

uint32 priority = 6;

Specified by:

getPriority in interface LoadReport.UpstreamLocalityStatsOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LoadReport.UpstreamLocalityStats 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.UpstreamLocalityStats parseFrom(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public LoadReport.UpstreamLocalityStats.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LoadReport.UpstreamLocalityStats.Builder newBuilder()

newBuilder

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

toBuilder

public LoadReport.UpstreamLocalityStats.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LoadReport.UpstreamLocalityStats getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder