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

Class LoadStatsResponse

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LoadStatsResponseOrBuilder, Serializable
    public final class LoadStatsResponse
extends com.google.protobuf.GeneratedMessageV3
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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  LoadStatsResponse.Builder
      The management server sends envoy a LoadStatsResponse with all clusters it is interested in learning load stats about.

      • 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/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • SEND_ALL_CLUSTERS_FIELD_NUMBER

        public static final int SEND_ALL_CLUSTERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOAD_REPORTING_INTERVAL_FIELD_NUMBER

        public static final int LOAD_REPORTING_INTERVAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPORT_ENDPOINT_GRANULARITY_FIELD_NUMBER

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

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

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

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

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

      • 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 LoadStatsResponse parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LoadStatsResponse parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LoadStatsResponse parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LoadStatsResponse parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LoadStatsResponse parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LoadStatsResponse parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LoadStatsResponse parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected LoadStatsResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<LoadStatsResponse> 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 LoadStatsResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder