Package io.envoyproxy.envoy.api.v2.endpoint

Class UpstreamLocalityStats.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UpstreamLocalityStatsOrBuilder, Cloneable
    Enclosing class:
    UpstreamLocalityStats
    public static final class UpstreamLocalityStats.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<UpstreamLocalityStats.Builder>
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

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

      • clear

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

      • getDefaultInstanceForType

        public UpstreamLocalityStats getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public UpstreamLocalityStats build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public UpstreamLocalityStats buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<UpstreamLocalityStats.Builder>

      • mergeFrom

        public 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<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 UpstreamLocalityStatsOrBuilder
        Returns:
        Whether the locality field is set.

      • 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
        Returns:
        The locality.

      • setLocality

        public UpstreamLocalityStats.Builder setLocality​(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 UpstreamLocalityStats.Builder setLocality​(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 UpstreamLocalityStats.Builder mergeLocality​(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 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 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;

      • 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
        Returns:
        The totalSuccessfulRequests.

      • setTotalSuccessfulRequests

        public UpstreamLocalityStats.Builder setTotalSuccessfulRequests​(long value)
         The total number of requests successfully completed by the endpoints in the
 locality.
        uint64 total_successful_requests = 2;
        Parameters:
        value - The totalSuccessfulRequests to set.
        Returns:
        This builder for chaining.

      • clearTotalSuccessfulRequests

        public UpstreamLocalityStats.Builder clearTotalSuccessfulRequests()
         The total number of requests successfully completed by the endpoints in the
 locality.
        uint64 total_successful_requests = 2;
        Returns:
        This builder for chaining.

      • setTotalRequestsInProgress

        public UpstreamLocalityStats.Builder setTotalRequestsInProgress​(long value)
         The total number of unfinished requests
        uint64 total_requests_in_progress = 3;
        Parameters:
        value - The totalRequestsInProgress to set.
        Returns:
        This builder for chaining.

      • clearTotalRequestsInProgress

        public UpstreamLocalityStats.Builder clearTotalRequestsInProgress()
         The total number of unfinished requests
        uint64 total_requests_in_progress = 3;
        Returns:
        This builder for chaining.

      • 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
        Returns:
        The totalErrorRequests.

      • setTotalErrorRequests

        public UpstreamLocalityStats.Builder setTotalErrorRequests​(long value)
         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;
        Parameters:
        value - The totalErrorRequests to set.
        Returns:
        This builder for chaining.

      • clearTotalErrorRequests

        public UpstreamLocalityStats.Builder clearTotalErrorRequests()
         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;
        Returns:
        This builder for chaining.

      • 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
        Returns:
        The totalIssuedRequests.

      • setTotalIssuedRequests

        public UpstreamLocalityStats.Builder setTotalIssuedRequests​(long value)
         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;
        Parameters:
        value - The totalIssuedRequests to set.
        Returns:
        This builder for chaining.

      • clearTotalIssuedRequests

        public UpstreamLocalityStats.Builder clearTotalIssuedRequests()
         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;
        Returns:
        This builder for chaining.

      • 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

      • clearLoadMetricStats

        public UpstreamLocalityStats.Builder clearLoadMetricStats()
         Stats for multi-dimensional load balancing.
        repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

      • removeLoadMetricStats

        public UpstreamLocalityStats.Builder removeLoadMetricStats​(int index)
         Stats for multi-dimensional load balancing.
        repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

      • getLoadMetricStatsBuilder

        public EndpointLoadMetricStats.Builder getLoadMetricStatsBuilder​(int index)
         Stats for multi-dimensional load balancing.
        repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

      • addLoadMetricStatsBuilder

        public EndpointLoadMetricStats.Builder addLoadMetricStatsBuilder()
         Stats for multi-dimensional load balancing.
        repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

      • addLoadMetricStatsBuilder

        public EndpointLoadMetricStats.Builder addLoadMetricStatsBuilder​(int index)
         Stats for multi-dimensional load balancing.
        repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

      • getLoadMetricStatsBuilderList

        public List<EndpointLoadMetricStats.Builder> getLoadMetricStatsBuilderList()
         Stats for multi-dimensional load balancing.
        repeated .envoy.api.v2.endpoint.EndpointLoadMetricStats load_metric_stats = 5;

      • getUpstreamEndpointStatsList

        public List<UpstreamEndpointStats> getUpstreamEndpointStatsList()
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;
        Specified by:
        getUpstreamEndpointStatsList in interface UpstreamLocalityStatsOrBuilder

      • getUpstreamEndpointStatsCount

        public int getUpstreamEndpointStatsCount()
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;
        Specified by:
        getUpstreamEndpointStatsCount in interface UpstreamLocalityStatsOrBuilder

      • getUpstreamEndpointStats

        public UpstreamEndpointStats getUpstreamEndpointStats​(int index)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;
        Specified by:
        getUpstreamEndpointStats in interface UpstreamLocalityStatsOrBuilder

      • setUpstreamEndpointStats

        public UpstreamLocalityStats.Builder setUpstreamEndpointStats​(int index,
                                                              UpstreamEndpointStats value)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • setUpstreamEndpointStats

        public UpstreamLocalityStats.Builder setUpstreamEndpointStats​(int index,
                                                              UpstreamEndpointStats.Builder builderForValue)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • addUpstreamEndpointStats

        public UpstreamLocalityStats.Builder addUpstreamEndpointStats​(UpstreamEndpointStats value)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • addUpstreamEndpointStats

        public UpstreamLocalityStats.Builder addUpstreamEndpointStats​(int index,
                                                              UpstreamEndpointStats value)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • addUpstreamEndpointStats

        public UpstreamLocalityStats.Builder addUpstreamEndpointStats​(UpstreamEndpointStats.Builder builderForValue)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • addUpstreamEndpointStats

        public UpstreamLocalityStats.Builder addUpstreamEndpointStats​(int index,
                                                              UpstreamEndpointStats.Builder builderForValue)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • addAllUpstreamEndpointStats

        public UpstreamLocalityStats.Builder addAllUpstreamEndpointStats​(Iterable<? extends UpstreamEndpointStats> values)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • clearUpstreamEndpointStats

        public UpstreamLocalityStats.Builder clearUpstreamEndpointStats()
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • removeUpstreamEndpointStats

        public UpstreamLocalityStats.Builder removeUpstreamEndpointStats​(int index)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • getUpstreamEndpointStatsBuilder

        public UpstreamEndpointStats.Builder getUpstreamEndpointStatsBuilder​(int index)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • getUpstreamEndpointStatsOrBuilder

        public UpstreamEndpointStatsOrBuilder getUpstreamEndpointStatsOrBuilder​(int index)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;
        Specified by:
        getUpstreamEndpointStatsOrBuilder in interface UpstreamLocalityStatsOrBuilder

      • getUpstreamEndpointStatsOrBuilderList

        public List<? extends UpstreamEndpointStatsOrBuilder> getUpstreamEndpointStatsOrBuilderList()
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;
        Specified by:
        getUpstreamEndpointStatsOrBuilderList in interface UpstreamLocalityStatsOrBuilder

      • addUpstreamEndpointStatsBuilder

        public UpstreamEndpointStats.Builder addUpstreamEndpointStatsBuilder()
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • addUpstreamEndpointStatsBuilder

        public UpstreamEndpointStats.Builder addUpstreamEndpointStatsBuilder​(int index)
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • getUpstreamEndpointStatsBuilderList

        public List<UpstreamEndpointStats.Builder> getUpstreamEndpointStatsBuilderList()
         Endpoint granularity stats information for this locality. This information
 is populated if the Server requests it by setting
 :ref:`LoadStatsResponse.report_endpoint_granularity<envoy_api_field_service.load_stats.v2.LoadStatsResponse.report_endpoint_granularity>`.
        repeated .envoy.api.v2.endpoint.UpstreamEndpointStats upstream_endpoint_stats = 7;

      • 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 UpstreamLocalityStatsOrBuilder
        Returns:
        The priority.

      • setPriority

        public UpstreamLocalityStats.Builder setPriority​(int value)
         [#not-implemented-hide:] The priority of the endpoint group these metrics
 were collected from.
        uint32 priority = 6;
        Parameters:
        value - The priority to set.
        Returns:
        This builder for chaining.

      • clearPriority

        public UpstreamLocalityStats.Builder clearPriority()
         [#not-implemented-hide:] The priority of the endpoint group these metrics
 were collected from.
        uint32 priority = 6;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final UpstreamLocalityStats.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UpstreamLocalityStats.Builder>

      • mergeUnknownFields

        public final UpstreamLocalityStats.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UpstreamLocalityStats.Builder>