UpstreamLocalityStats (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.api.v2.endpoint.UpstreamLocalityStats

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UpstreamLocalityStatsOrBuilder, Serializable

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

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

Protobuf type envoy.api.v2.endpoint.UpstreamLocalityStats

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class 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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

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_ISSUED_REQUESTS_FIELD_NUMBER`
`static int`	`TOTAL_REQUESTS_IN_PROGRESS_FIELD_NUMBER`
`static int`	`TOTAL_SUCCESSFUL_REQUESTS_FIELD_NUMBER`
`static int`	`UPSTREAM_ENDPOINT_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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static UpstreamLocalityStats`	`getDefaultInstance()`
`UpstreamLocalityStats`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`EndpointLoadMetricStats`	`getLoadMetricStats(int index)` Stats for multi-dimensional load balancing.
`int`	`getLoadMetricStatsCount()` Stats for multi-dimensional load balancing.
`List<EndpointLoadMetricStats>`	`getLoadMetricStatsList()` Stats for multi-dimensional load balancing.
`EndpointLoadMetricStatsOrBuilder`	`getLoadMetricStatsOrBuilder(int index)` Stats for multi-dimensional load balancing.
`List<? extends EndpointLoadMetricStatsOrBuilder>`	`getLoadMetricStatsOrBuilderList()` Stats for multi-dimensional load balancing.
`Locality`	`getLocality()` Name of zone, region and optionally endpoint group these metrics were collected from.
`LocalityOrBuilder`	`getLocalityOrBuilder()` Name of zone, region and optionally endpoint group these metrics were collected from.
`com.google.protobuf.Parser<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, aggregated over all endpoints in the locality.
`long`	`getTotalIssuedRequests()` The total number of requests that were issued by this Envoy since the last report.
`long`	`getTotalRequestsInProgress()` The total number of unfinished requests `uint64 total_requests_in_progress = 3;`
`long`	`getTotalSuccessfulRequests()` The total number of requests successfully completed by the endpoints in the locality.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`UpstreamEndpointStats`	`getUpstreamEndpointStats(int index)` Endpoint granularity stats information for this locality.
`int`	`getUpstreamEndpointStatsCount()` Endpoint granularity stats information for this locality.
`List<UpstreamEndpointStats>`	`getUpstreamEndpointStatsList()` Endpoint granularity stats information for this locality.
`UpstreamEndpointStatsOrBuilder`	`getUpstreamEndpointStatsOrBuilder(int index)` Endpoint granularity stats information for this locality.
`List<? extends UpstreamEndpointStatsOrBuilder>`	`getUpstreamEndpointStatsOrBuilderList()` Endpoint granularity stats information for this locality.
`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 UpstreamLocalityStats.Builder`	`newBuilder()`
`static UpstreamLocalityStats.Builder`	`newBuilder(UpstreamLocalityStats prototype)`
`UpstreamLocalityStats.Builder`	`newBuilderForType()`
`protected UpstreamLocalityStats.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static UpstreamLocalityStats`	`parseDelimitedFrom(InputStream input)`
`static UpstreamLocalityStats`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UpstreamLocalityStats`	`parseFrom(byte[] data)`
`static UpstreamLocalityStats`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UpstreamLocalityStats`	`parseFrom(ByteBuffer data)`
`static UpstreamLocalityStats`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UpstreamLocalityStats`	`parseFrom(com.google.protobuf.ByteString data)`
`static UpstreamLocalityStats`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UpstreamLocalityStats`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static UpstreamLocalityStats`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UpstreamLocalityStats`	`parseFrom(InputStream input)`
`static UpstreamLocalityStats`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<UpstreamLocalityStats>`	`parser()`
`UpstreamLocalityStats.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
- 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
- TOTAL_ISSUED_REQUESTS_FIELD_NUMBER
```
public static final int TOTAL_ISSUED_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
- UPSTREAM_ENDPOINT_STATS_FIELD_NUMBER
```
public static final int UPSTREAM_ENDPOINT_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

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

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 UpstreamLocalityStatsOrBuilder

getLocality

public 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 UpstreamLocalityStatsOrBuilder

getLocalityOrBuilder

public 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 UpstreamLocalityStatsOrBuilder

getTotalSuccessfulRequests
```
public long getTotalSuccessfulRequests()
```
```
 The total number of requests successfully completed by the endpoints in the
 locality.
 
```
uint64 total_successful_requests = 2;
Specified by:

getTotalSuccessfulRequests in interface UpstreamLocalityStatsOrBuilder

getTotalRequestsInProgress
```
public long getTotalRequestsInProgress()
```
```
 The total number of unfinished requests
 
```
uint64 total_requests_in_progress = 3;
Specified by:

getTotalRequestsInProgress in interface UpstreamLocalityStatsOrBuilder

getTotalErrorRequests

public long getTotalErrorRequests()

 The total number of requests that failed due to errors at the endpoint,
 aggregated over all endpoints in the locality.

uint64 total_error_requests = 4;

Specified by:: getTotalErrorRequests in interface UpstreamLocalityStatsOrBuilder

getTotalIssuedRequests

public long getTotalIssuedRequests()

 The total number of requests that were issued by this Envoy since
 the last report. This information is aggregated over all the
 upstream endpoints in the locality.

uint64 total_issued_requests = 8;

Specified by:: getTotalIssuedRequests in interface UpstreamLocalityStatsOrBuilder

getLoadMetricStatsList
```
public List<EndpointLoadMetricStats> getLoadMetricStatsList()
```
```
 Stats for multi-dimensional load balancing.
 
```
repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;
Specified by:

getLoadMetricStatsList in interface UpstreamLocalityStatsOrBuilder

getLoadMetricStatsOrBuilderList
```
public List<? extends EndpointLoadMetricStatsOrBuilder> getLoadMetricStatsOrBuilderList()
```
```
 Stats for multi-dimensional load balancing.
 
```
repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;
Specified by:

getLoadMetricStatsOrBuilderList in interface 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 UpstreamLocalityStatsOrBuilder

getLoadMetricStats
```
public 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 UpstreamLocalityStatsOrBuilder

getLoadMetricStatsOrBuilder
```
public 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 UpstreamLocalityStatsOrBuilder