Class LoadStatsResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.service.load_stats.v3.LoadStatsResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LoadStatsResponseOrBuilder, Serializable
@Generated 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CLUSTERS_FIELD_NUMBER
     
    static final int
    LOAD_REPORTING_INTERVAL_FIELD_NUMBER
     
    static final int
    REPORT_ENDPOINT_GRANULARITY_FIELD_NUMBER
     
    static final int
    SEND_ALL_CLUSTERS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getClusters(int index)
    Clusters to report stats for.
    com.google.protobuf.ByteString
    getClustersBytes(int index)
    Clusters to report stats for.
    int
    getClustersCount()
    Clusters to report stats for.
    com.google.protobuf.ProtocolStringList
    getClustersList()
    Clusters to report stats for.
    static LoadStatsResponse
    getDefaultInstance()
     
    LoadStatsResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    com.google.protobuf.Duration
    getLoadReportingInterval()
    The minimum interval of time to collect stats over.
    com.google.protobuf.DurationOrBuilder
    getLoadReportingIntervalOrBuilder()
    The minimum interval of time to collect stats over.
    com.google.protobuf.Parser<LoadStatsResponse>
    getParserForType()
     
    boolean
    getReportEndpointGranularity()
    Set to ``true`` if the management server supports endpoint granularity report.
    boolean
    getSendAllClusters()
    If true, the client should send all clusters it knows about.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasLoadReportingInterval()
    The minimum interval of time to collect stats over.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static LoadStatsResponse.Builder
    newBuilder()
     
    static LoadStatsResponse.Builder
    newBuilder(LoadStatsResponse prototype)
     
    LoadStatsResponse.Builder
    newBuilderForType()
     
    protected LoadStatsResponse.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static LoadStatsResponse
    parseDelimitedFrom(InputStream input)
     
    static LoadStatsResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LoadStatsResponse
    parseFrom(byte[] data)
     
    static LoadStatsResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LoadStatsResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static LoadStatsResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LoadStatsResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static LoadStatsResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LoadStatsResponse
    parseFrom(InputStream input)
     
    static LoadStatsResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LoadStatsResponse
    parseFrom(ByteBuffer data)
     
    static LoadStatsResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<LoadStatsResponse>
    parser()
     
    LoadStatsResponse.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • CLUSTERS_FIELD_NUMBER

      public static final int CLUSTERS_FIELD_NUMBER
      See Also:

    • SEND_ALL_CLUSTERS_FIELD_NUMBER

      public static final int SEND_ALL_CLUSTERS_FIELD_NUMBER
      See Also:

    • LOAD_REPORTING_INTERVAL_FIELD_NUMBER

      public static final int LOAD_REPORTING_INTERVAL_FIELD_NUMBER
      See Also:

    • REPORT_ENDPOINT_GRANULARITY_FIELD_NUMBER

      public static final int REPORT_ENDPOINT_GRANULARITY_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • 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 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static LoadStatsResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static LoadStatsResponse.Builder newBuilder()

    • newBuilder

      public static LoadStatsResponse.Builder newBuilder(LoadStatsResponse prototype)

    • 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

    • getDefaultInstance

      public static LoadStatsResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<LoadStatsResponse> parser()

    • 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