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

Interface LoadStatsResponseOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    LoadStatsResponse, LoadStatsResponse.Builder
    public interface LoadStatsResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      List<String> getClustersList()
      Clusters to report stats for.
      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.
      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.
      boolean hasLoadReportingInterval()
      The minimum interval of time to collect stats over.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getClustersList

        List<String> getClustersList()
         Clusters to report stats for.
 Not populated if ``send_all_clusters`` is true.
        repeated string clusters = 1;
        Returns:
        A list containing the clusters.

      • getClustersCount

        int getClustersCount()
         Clusters to report stats for.
 Not populated if ``send_all_clusters`` is true.
        repeated string clusters = 1;
        Returns:
        The count of clusters.

      • getClusters

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

      • getClustersBytes

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

      • getSendAllClusters

        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;
        Returns:
        The sendAllClusters.

      • hasLoadReportingInterval

        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;
        Returns:
        Whether the loadReportingInterval field is set.

      • getLoadReportingInterval

        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;
        Returns:
        The loadReportingInterval.

      • getLoadReportingIntervalOrBuilder

        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;

      • getReportEndpointGranularity

        boolean getReportEndpointGranularity()
         Set to ``true`` if the management server supports endpoint granularity
 report.
        bool report_endpoint_granularity = 3;
        Returns:
        The reportEndpointGranularity.