LoadReport.UpstreamLocalityStats.Builder (api 0.1.4 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>
    - - envoy.api.v2.endpoint.LoadReport.UpstreamLocalityStats.Builder

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LoadReport.UpstreamLocalityStatsOrBuilder, Cloneable

Enclosing class:: LoadReport.UpstreamLocalityStats

public static final class LoadReport.UpstreamLocalityStats.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>
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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LoadReport.UpstreamLocalityStats.Builder`	`addAllLoadMetricStats(Iterable<? extends LoadReport.EndpointLoadMetricStats> values)` Stats for multi-dimensional load balancing.
`LoadReport.UpstreamLocalityStats.Builder`	`addLoadMetricStats(int index, LoadReport.EndpointLoadMetricStats.Builder builderForValue)` Stats for multi-dimensional load balancing.
`LoadReport.UpstreamLocalityStats.Builder`	`addLoadMetricStats(int index, LoadReport.EndpointLoadMetricStats value)` Stats for multi-dimensional load balancing.
`LoadReport.UpstreamLocalityStats.Builder`	`addLoadMetricStats(LoadReport.EndpointLoadMetricStats.Builder builderForValue)` Stats for multi-dimensional load balancing.
`LoadReport.UpstreamLocalityStats.Builder`	`addLoadMetricStats(LoadReport.EndpointLoadMetricStats value)` Stats for multi-dimensional load balancing.
`LoadReport.EndpointLoadMetricStats.Builder`	`addLoadMetricStatsBuilder()` Stats for multi-dimensional load balancing.
`LoadReport.EndpointLoadMetricStats.Builder`	`addLoadMetricStatsBuilder(int index)` Stats for multi-dimensional load balancing.
`LoadReport.UpstreamLocalityStats.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`LoadReport.UpstreamLocalityStats`	`build()`
`LoadReport.UpstreamLocalityStats`	`buildPartial()`
`LoadReport.UpstreamLocalityStats.Builder`	`clear()`
`LoadReport.UpstreamLocalityStats.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`LoadReport.UpstreamLocalityStats.Builder`	`clearLoadMetricStats()` Stats for multi-dimensional load balancing.
`LoadReport.UpstreamLocalityStats.Builder`	`clearLocality()` Name of zone, region and optionally endpoint group these metrics were collected from.
`LoadReport.UpstreamLocalityStats.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`LoadReport.UpstreamLocalityStats.Builder`	`clearPriority()` [#not-implemented-hide:] The priority of the endpoint group these metrics were collected from.
`LoadReport.UpstreamLocalityStats.Builder`	`clearTotalErrorRequests()` The total number of requests that failed due to errors at the endpoint.
`LoadReport.UpstreamLocalityStats.Builder`	`clearTotalRequestsInProgress()` The total number of unfinished requests `uint64 total_requests_in_progress = 3;`
`LoadReport.UpstreamLocalityStats.Builder`	`clearTotalSuccessfulRequests()` The total number of requests sent by this Envoy since the last report.
`LoadReport.UpstreamLocalityStats.Builder`	`clone()`
`LoadReport.UpstreamLocalityStats`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`LoadReport.EndpointLoadMetricStats`	`getLoadMetricStats(int index)` Stats for multi-dimensional load balancing.
`LoadReport.EndpointLoadMetricStats.Builder`	`getLoadMetricStatsBuilder(int index)` Stats for multi-dimensional load balancing.
`List<LoadReport.EndpointLoadMetricStats.Builder>`	`getLoadMetricStatsBuilderList()` 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.Locality.Builder`	`getLocalityBuilder()` 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.
`int`	`getPriority()` [#not-implemented-hide:] The priority of the endpoint group these metrics were collected from.
`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.
`boolean`	`hasLocality()` Name of zone, region and optionally endpoint group these metrics were collected from.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`LoadReport.UpstreamLocalityStats.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`LoadReport.UpstreamLocalityStats.Builder`	`mergeFrom(LoadReport.UpstreamLocalityStats other)`
`LoadReport.UpstreamLocalityStats.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`LoadReport.UpstreamLocalityStats.Builder`	`mergeLocality(Base.Locality value)` Name of zone, region and optionally endpoint group these metrics were collected from.
`LoadReport.UpstreamLocalityStats.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`LoadReport.UpstreamLocalityStats.Builder`	`removeLoadMetricStats(int index)` Stats for multi-dimensional load balancing.
`LoadReport.UpstreamLocalityStats.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`LoadReport.UpstreamLocalityStats.Builder`	`setLoadMetricStats(int index, LoadReport.EndpointLoadMetricStats.Builder builderForValue)` Stats for multi-dimensional load balancing.
`LoadReport.UpstreamLocalityStats.Builder`	`setLoadMetricStats(int index, LoadReport.EndpointLoadMetricStats value)` Stats for multi-dimensional load balancing.
`LoadReport.UpstreamLocalityStats.Builder`	`setLocality(Base.Locality.Builder builderForValue)` Name of zone, region and optionally endpoint group these metrics were collected from.
`LoadReport.UpstreamLocalityStats.Builder`	`setLocality(Base.Locality value)` Name of zone, region and optionally endpoint group these metrics were collected from.
`LoadReport.UpstreamLocalityStats.Builder`	`setPriority(int value)` [#not-implemented-hide:] The priority of the endpoint group these metrics were collected from.
`LoadReport.UpstreamLocalityStats.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`LoadReport.UpstreamLocalityStats.Builder`	`setTotalErrorRequests(long value)` The total number of requests that failed due to errors at the endpoint.
`LoadReport.UpstreamLocalityStats.Builder`	`setTotalRequestsInProgress(long value)` The total number of unfinished requests `uint64 total_requests_in_progress = 3;`
`LoadReport.UpstreamLocalityStats.Builder`	`setTotalSuccessfulRequests(long value)` The total number of requests sent by this Envoy since the last report.
`LoadReport.UpstreamLocalityStats.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

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.Builder<LoadReport.UpstreamLocalityStats.Builder>

clear
```
public LoadReport.UpstreamLocalityStats.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>

getDefaultInstanceForType
```
public LoadReport.UpstreamLocalityStats getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public LoadReport.UpstreamLocalityStats build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public LoadReport.UpstreamLocalityStats buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public LoadReport.UpstreamLocalityStats.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>

setField

public LoadReport.UpstreamLocalityStats.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>

clearField
```
public LoadReport.UpstreamLocalityStats.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>

clearOneof
```
public LoadReport.UpstreamLocalityStats.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>

setRepeatedField

public LoadReport.UpstreamLocalityStats.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                 int index,
                                                                 Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>

addRepeatedField

public LoadReport.UpstreamLocalityStats.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                 Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>

mergeFrom
```
public LoadReport.UpstreamLocalityStats.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LoadReport.UpstreamLocalityStats.Builder>

mergeFrom

public LoadReport.UpstreamLocalityStats.Builder mergeFrom(LoadReport.UpstreamLocalityStats other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LoadReport.UpstreamLocalityStats.Builder>

mergeFrom

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

Specified by:: mergeFrom in interface com.google.protobuf.Message.Builder
Specified by:: mergeFrom in interface com.google.protobuf.MessageLite.Builder
Overrides:: mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LoadReport.UpstreamLocalityStats.Builder>
Throws:: IOException

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

setLocality

public LoadReport.UpstreamLocalityStats.Builder setLocality(Base.Locality value)

 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;

setLocality

public LoadReport.UpstreamLocalityStats.Builder setLocality(Base.Locality.Builder builderForValue)

 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;

mergeLocality

public LoadReport.UpstreamLocalityStats.Builder mergeLocality(Base.Locality value)

 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;

clearLocality

public LoadReport.UpstreamLocalityStats.Builder clearLocality()

 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;

getLocalityBuilder

public Base.Locality.Builder getLocalityBuilder()

 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;

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

setTotalSuccessfulRequests

public LoadReport.UpstreamLocalityStats.Builder setTotalSuccessfulRequests(long value)

 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;

clearTotalSuccessfulRequests

public LoadReport.UpstreamLocalityStats.Builder clearTotalSuccessfulRequests()

 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;

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

getTotalRequestsInProgress in interface LoadReport.UpstreamLocalityStatsOrBuilder

setTotalRequestsInProgress

public LoadReport.UpstreamLocalityStats.Builder setTotalRequestsInProgress(long value)

 The total number of unfinished requests

uint64 total_requests_in_progress = 3;

clearTotalRequestsInProgress

public LoadReport.UpstreamLocalityStats.Builder clearTotalRequestsInProgress()

 The total number of unfinished requests

uint64 total_requests_in_progress = 3;

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

setTotalErrorRequests

public LoadReport.UpstreamLocalityStats.Builder setTotalErrorRequests(long value)

 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;

clearTotalErrorRequests

public LoadReport.UpstreamLocalityStats.Builder clearTotalErrorRequests()

 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;

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

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