Package io.envoyproxy.envoy.service.load_stats.v2

Class LoadStatsResponse.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LoadStatsResponseOrBuilder, Cloneable
    Enclosing class:
    LoadStatsResponse
    public static final class LoadStatsResponse.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LoadStatsResponse.Builder>
implements LoadStatsResponseOrBuilder
     The management server sends envoy a LoadStatsResponse with all clusters it
 is interested in learning load stats about.
 [#not-implemented-hide:] Not configuration. TBD how to doc proto APIs.
    Protobuf type envoy.service.load_stats.v2.LoadStatsResponse

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

        public LoadStatsResponse.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<LoadStatsResponse.Builder>
        Throws:
        IOException

      • getClustersList

        public com.google.protobuf.ProtocolStringList getClustersList()
         Clusters to report stats for.
 Not populated if *send_all_clusters* is true.
        repeated string clusters = 1;
        Specified by:
        getClustersList in interface LoadStatsResponseOrBuilder
        Returns:
        A list containing the clusters.

      • getClustersCount

        public int getClustersCount()
         Clusters to report stats for.
 Not populated if *send_all_clusters* is true.
        repeated string clusters = 1;
        Specified by:
        getClustersCount in interface LoadStatsResponseOrBuilder
        Returns:
        The count of clusters.

      • getClusters

        public String getClusters​(int index)
         Clusters to report stats for.
 Not populated if *send_all_clusters* is true.
        repeated string clusters = 1;
        Specified by:
        getClusters in interface LoadStatsResponseOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The clusters at the given index.

      • getClustersBytes

        public com.google.protobuf.ByteString getClustersBytes​(int index)
         Clusters to report stats for.
 Not populated if *send_all_clusters* is true.
        repeated string clusters = 1;
        Specified by:
        getClustersBytes in interface LoadStatsResponseOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the clusters at the given index.

      • setClusters

        public LoadStatsResponse.Builder setClusters​(int index,
                                             String value)
         Clusters to report stats for.
 Not populated if *send_all_clusters* is true.
        repeated string clusters = 1;
        Parameters:
        index - The index to set the value at.
        value - The clusters to set.
        Returns:
        This builder for chaining.

      • addClusters

        public LoadStatsResponse.Builder addClusters​(String value)
         Clusters to report stats for.
 Not populated if *send_all_clusters* is true.
        repeated string clusters = 1;
        Parameters:
        value - The clusters to add.
        Returns:
        This builder for chaining.

      • addAllClusters

        public LoadStatsResponse.Builder addAllClusters​(Iterable<String> values)
         Clusters to report stats for.
 Not populated if *send_all_clusters* is true.
        repeated string clusters = 1;
        Parameters:
        values - The clusters to add.
        Returns:
        This builder for chaining.

      • clearClusters

        public LoadStatsResponse.Builder clearClusters()
         Clusters to report stats for.
 Not populated if *send_all_clusters* is true.
        repeated string clusters = 1;
        Returns:
        This builder for chaining.

      • addClustersBytes

        public LoadStatsResponse.Builder addClustersBytes​(com.google.protobuf.ByteString value)
         Clusters to report stats for.
 Not populated if *send_all_clusters* is true.
        repeated string clusters = 1;
        Parameters:
        value - The bytes of the clusters to add.
        Returns:
        This builder for chaining.

      • getSendAllClusters

        public boolean getSendAllClusters()
         If true, the client should send all clusters it knows about.
 Only clients that advertise the "envoy.lrs.supports_send_all_clusters" capability in their
 :ref:`client_features<envoy_api_field_core.Node.client_features>` field will honor this field.
        bool send_all_clusters = 4;
        Specified by:
        getSendAllClusters in interface LoadStatsResponseOrBuilder
        Returns:
        The sendAllClusters.

      • setSendAllClusters

        public LoadStatsResponse.Builder setSendAllClusters​(boolean value)
         If true, the client should send all clusters it knows about.
 Only clients that advertise the "envoy.lrs.supports_send_all_clusters" capability in their
 :ref:`client_features<envoy_api_field_core.Node.client_features>` field will honor this field.
        bool send_all_clusters = 4;
        Parameters:
        value - The sendAllClusters to set.
        Returns:
        This builder for chaining.

      • clearSendAllClusters

        public LoadStatsResponse.Builder clearSendAllClusters()
         If true, the client should send all clusters it knows about.
 Only clients that advertise the "envoy.lrs.supports_send_all_clusters" capability in their
 :ref:`client_features<envoy_api_field_core.Node.client_features>` field will honor this field.
        bool send_all_clusters = 4;
        Returns:
        This builder for chaining.

      • hasLoadReportingInterval

        public boolean hasLoadReportingInterval()
         The minimum interval of time to collect stats over. This is only a minimum for two reasons:
 1. There may be some delay from when the timer fires until stats sampling occurs.
 2. For clusters that were already feature in the previous *LoadStatsResponse*, any traffic
    that is observed in between the corresponding previous *LoadStatsRequest* and this
    *LoadStatsResponse* will also be accumulated and billed to the cluster. This avoids a period
    of inobservability that might otherwise exists between the messages. New clusters are not
    subject to this consideration.
        .google.protobuf.Duration load_reporting_interval = 2;
        Specified by:
        hasLoadReportingInterval in interface LoadStatsResponseOrBuilder
        Returns:
        Whether the loadReportingInterval field is set.

      • getLoadReportingInterval

        public com.google.protobuf.Duration getLoadReportingInterval()
         The minimum interval of time to collect stats over. This is only a minimum for two reasons:
 1. There may be some delay from when the timer fires until stats sampling occurs.
 2. For clusters that were already feature in the previous *LoadStatsResponse*, any traffic
    that is observed in between the corresponding previous *LoadStatsRequest* and this
    *LoadStatsResponse* will also be accumulated and billed to the cluster. This avoids a period
    of inobservability that might otherwise exists between the messages. New clusters are not
    subject to this consideration.
        .google.protobuf.Duration load_reporting_interval = 2;
        Specified by:
        getLoadReportingInterval in interface LoadStatsResponseOrBuilder
        Returns:
        The loadReportingInterval.

      • setLoadReportingInterval

        public LoadStatsResponse.Builder setLoadReportingInterval​(com.google.protobuf.Duration value)
         The minimum interval of time to collect stats over. This is only a minimum for two reasons:
 1. There may be some delay from when the timer fires until stats sampling occurs.
 2. For clusters that were already feature in the previous *LoadStatsResponse*, any traffic
    that is observed in between the corresponding previous *LoadStatsRequest* and this
    *LoadStatsResponse* will also be accumulated and billed to the cluster. This avoids a period
    of inobservability that might otherwise exists between the messages. New clusters are not
    subject to this consideration.
        .google.protobuf.Duration load_reporting_interval = 2;

      • setLoadReportingInterval

        public LoadStatsResponse.Builder setLoadReportingInterval​(com.google.protobuf.Duration.Builder builderForValue)
         The minimum interval of time to collect stats over. This is only a minimum for two reasons:
 1. There may be some delay from when the timer fires until stats sampling occurs.
 2. For clusters that were already feature in the previous *LoadStatsResponse*, any traffic
    that is observed in between the corresponding previous *LoadStatsRequest* and this
    *LoadStatsResponse* will also be accumulated and billed to the cluster. This avoids a period
    of inobservability that might otherwise exists between the messages. New clusters are not
    subject to this consideration.
        .google.protobuf.Duration load_reporting_interval = 2;

      • mergeLoadReportingInterval

        public LoadStatsResponse.Builder mergeLoadReportingInterval​(com.google.protobuf.Duration value)
         The minimum interval of time to collect stats over. This is only a minimum for two reasons:
 1. There may be some delay from when the timer fires until stats sampling occurs.
 2. For clusters that were already feature in the previous *LoadStatsResponse*, any traffic
    that is observed in between the corresponding previous *LoadStatsRequest* and this
    *LoadStatsResponse* will also be accumulated and billed to the cluster. This avoids a period
    of inobservability that might otherwise exists between the messages. New clusters are not
    subject to this consideration.
        .google.protobuf.Duration load_reporting_interval = 2;

      • clearLoadReportingInterval

        public LoadStatsResponse.Builder clearLoadReportingInterval()
         The minimum interval of time to collect stats over. This is only a minimum for two reasons:
 1. There may be some delay from when the timer fires until stats sampling occurs.
 2. For clusters that were already feature in the previous *LoadStatsResponse*, any traffic
    that is observed in between the corresponding previous *LoadStatsRequest* and this
    *LoadStatsResponse* will also be accumulated and billed to the cluster. This avoids a period
    of inobservability that might otherwise exists between the messages. New clusters are not
    subject to this consideration.
        .google.protobuf.Duration load_reporting_interval = 2;

      • getLoadReportingIntervalBuilder

        public com.google.protobuf.Duration.Builder getLoadReportingIntervalBuilder()
         The minimum interval of time to collect stats over. This is only a minimum for two reasons:
 1. There may be some delay from when the timer fires until stats sampling occurs.
 2. For clusters that were already feature in the previous *LoadStatsResponse*, any traffic
    that is observed in between the corresponding previous *LoadStatsRequest* and this
    *LoadStatsResponse* will also be accumulated and billed to the cluster. This avoids a period
    of inobservability that might otherwise exists between the messages. New clusters are not
    subject to this consideration.
        .google.protobuf.Duration load_reporting_interval = 2;

      • getLoadReportingIntervalOrBuilder

        public com.google.protobuf.DurationOrBuilder getLoadReportingIntervalOrBuilder()
         The minimum interval of time to collect stats over. This is only a minimum for two reasons:
 1. There may be some delay from when the timer fires until stats sampling occurs.
 2. For clusters that were already feature in the previous *LoadStatsResponse*, any traffic
    that is observed in between the corresponding previous *LoadStatsRequest* and this
    *LoadStatsResponse* will also be accumulated and billed to the cluster. This avoids a period
    of inobservability that might otherwise exists between the messages. New clusters are not
    subject to this consideration.
        .google.protobuf.Duration load_reporting_interval = 2;
        Specified by:
        getLoadReportingIntervalOrBuilder in interface LoadStatsResponseOrBuilder

      • getReportEndpointGranularity

        public boolean getReportEndpointGranularity()
         Set to *true* if the management server supports endpoint granularity
 report.
        bool report_endpoint_granularity = 3;
        Specified by:
        getReportEndpointGranularity in interface LoadStatsResponseOrBuilder
        Returns:
        The reportEndpointGranularity.

      • setReportEndpointGranularity

        public LoadStatsResponse.Builder setReportEndpointGranularity​(boolean value)
         Set to *true* if the management server supports endpoint granularity
 report.
        bool report_endpoint_granularity = 3;
        Parameters:
        value - The reportEndpointGranularity to set.
        Returns:
        This builder for chaining.

      • clearReportEndpointGranularity

        public LoadStatsResponse.Builder clearReportEndpointGranularity()
         Set to *true* if the management server supports endpoint granularity
 report.
        bool report_endpoint_granularity = 3;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final LoadStatsResponse.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<LoadStatsResponse.Builder>

      • mergeUnknownFields

        public final LoadStatsResponse.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<LoadStatsResponse.Builder>