Package io.envoyproxy.envoy.service.load_stats.v3

Class LoadStatsResponse

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LoadStatsResponseOrBuilder, java.io.Serializable
    public final class LoadStatsResponse
extends com.google.protobuf.GeneratedMessage
implements LoadStatsResponseOrBuilder
     The management server sends envoy a LoadStatsResponse with all clusters it
 is interested in learning load stats about.
    Protobuf type envoy.service.load_stats.v3.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.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private LoadStatsResponse()  
      private LoadStatsResponse​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  

    • Field Detail

      • bitField0_

        private int bitField0_

      • clusters_

        private com.google.protobuf.LazyStringArrayList clusters_

      • SEND_ALL_CLUSTERS_FIELD_NUMBER

        public static final int SEND_ALL_CLUSTERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • sendAllClusters_

        private boolean sendAllClusters_

      • LOAD_REPORTING_INTERVAL_FIELD_NUMBER

        public static final int LOAD_REPORTING_INTERVAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • loadReportingInterval_

        private com.google.protobuf.Duration loadReportingInterval_

      • REPORT_ENDPOINT_GRANULARITY_FIELD_NUMBER

        public static final int REPORT_ENDPOINT_GRANULARITY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • reportEndpointGranularity_

        private boolean reportEndpointGranularity_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

    • Constructor Detail

      • LoadStatsResponse

        private LoadStatsResponse​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • LoadStatsResponse

        private LoadStatsResponse()

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • 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 java.lang.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_v3_api_field_config.core.v3.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.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LoadStatsResponse parseFrom​(java.nio.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​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static LoadStatsResponse parseDelimitedFrom​(java.io.InputStream input)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static LoadStatsResponse parseDelimitedFrom​(java.io.InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static LoadStatsResponse parseFrom​(com.google.protobuf.CodedInputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static LoadStatsResponse parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

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

      • getDefaultInstanceForType

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