Package com.github.xds.data.orca.v3

Interface OrcaLoadReportOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsNamedMetrics​(java.lang.String key)
      Application specific opaque metrics.
      boolean containsRequestCost​(java.lang.String key)
      Application specific requests costs.
      boolean containsUtilization​(java.lang.String key)
      Resource utilization values.
      double getApplicationUtilization()
      Application specific utilization expressed as a fraction of available resources.
      double getCpuUtilization()
      CPU utilization expressed as a fraction of available CPU resources.
      double getEps()
      Total EPS (errors/second) being served by an endpoint.
      double getMemUtilization()
      Memory utilization expressed as a fraction of available memory resources.
      java.util.Map<java.lang.String,​java.lang.Double> getNamedMetrics()
      Deprecated.
      int getNamedMetricsCount()
      Application specific opaque metrics.
      java.util.Map<java.lang.String,​java.lang.Double> getNamedMetricsMap()
      Application specific opaque metrics.
      double getNamedMetricsOrDefault​(java.lang.String key, double defaultValue)
      Application specific opaque metrics.
      double getNamedMetricsOrThrow​(java.lang.String key)
      Application specific opaque metrics.
      java.util.Map<java.lang.String,​java.lang.Double> getRequestCost()
      Deprecated.
      int getRequestCostCount()
      Application specific requests costs.
      java.util.Map<java.lang.String,​java.lang.Double> getRequestCostMap()
      Application specific requests costs.
      double getRequestCostOrDefault​(java.lang.String key, double defaultValue)
      Application specific requests costs.
      double getRequestCostOrThrow​(java.lang.String key)
      Application specific requests costs.
      long getRps()
      Deprecated.
      xds.data.orca.v3.OrcaLoadReport.rps is deprecated.
      double getRpsFractional()
      Total RPS being served by an endpoint.
      java.util.Map<java.lang.String,​java.lang.Double> getUtilization()
      Deprecated.
      int getUtilizationCount()
      Resource utilization values.
      java.util.Map<java.lang.String,​java.lang.Double> getUtilizationMap()
      Resource utilization values.
      double getUtilizationOrDefault​(java.lang.String key, double defaultValue)
      Resource utilization values.
      double getUtilizationOrThrow​(java.lang.String key)
      Resource utilization values.

      • 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

      • getCpuUtilization

        double getCpuUtilization()
         CPU utilization expressed as a fraction of available CPU resources. This
 should be derived from the latest sample or measurement. The value may be
 larger than 1.0 when the usage exceeds the reporter dependent notion of
 soft limits.
        double cpu_utilization = 1 [(.validate.rules) = { ... }
        Returns:
        The cpuUtilization.

      • getMemUtilization

        double getMemUtilization()
         Memory utilization expressed as a fraction of available memory
 resources. This should be derived from the latest sample or measurement.
        double mem_utilization = 2 [(.validate.rules) = { ... }
        Returns:
        The memUtilization.

      • getRps

        @Deprecated
long getRps()
        Deprecated.
        xds.data.orca.v3.OrcaLoadReport.rps is deprecated. See xds/data/orca/v3/orca_load_report.proto;l=28
         Total RPS being served by an endpoint. This should cover all services that an endpoint is
 responsible for.
 Deprecated -- use ``rps_fractional`` field instead.
        uint64 rps = 3 [deprecated = true];
        Returns:
        The rps.

      • getRequestCostCount

        int getRequestCostCount()
         Application specific requests costs. Each value is an absolute cost (e.g. 3487 bytes of
 storage) associated with the request.
        map<string, double> request_cost = 4;

      • containsRequestCost

        boolean containsRequestCost​(java.lang.String key)
         Application specific requests costs. Each value is an absolute cost (e.g. 3487 bytes of
 storage) associated with the request.
        map<string, double> request_cost = 4;

      • getRequestCost

        @Deprecated
java.util.Map<java.lang.String,​java.lang.Double> getRequestCost()
        Deprecated.
        Use getRequestCostMap() instead.

      • getRequestCostMap

        java.util.Map<java.lang.String,​java.lang.Double> getRequestCostMap()
         Application specific requests costs. Each value is an absolute cost (e.g. 3487 bytes of
 storage) associated with the request.
        map<string, double> request_cost = 4;

      • getRequestCostOrDefault

        double getRequestCostOrDefault​(java.lang.String key,
                               double defaultValue)
         Application specific requests costs. Each value is an absolute cost (e.g. 3487 bytes of
 storage) associated with the request.
        map<string, double> request_cost = 4;

      • getRequestCostOrThrow

        double getRequestCostOrThrow​(java.lang.String key)
         Application specific requests costs. Each value is an absolute cost (e.g. 3487 bytes of
 storage) associated with the request.
        map<string, double> request_cost = 4;

      • getUtilizationCount

        int getUtilizationCount()
         Resource utilization values. Each value is expressed as a fraction of total resources
 available, derived from the latest sample or measurement.
        map<string, double> utilization = 5 [(.validate.rules) = { ... }

      • containsUtilization

        boolean containsUtilization​(java.lang.String key)
         Resource utilization values. Each value is expressed as a fraction of total resources
 available, derived from the latest sample or measurement.
        map<string, double> utilization = 5 [(.validate.rules) = { ... }

      • getUtilization

        @Deprecated
java.util.Map<java.lang.String,​java.lang.Double> getUtilization()
        Deprecated.
        Use getUtilizationMap() instead.

      • getUtilizationMap

        java.util.Map<java.lang.String,​java.lang.Double> getUtilizationMap()
         Resource utilization values. Each value is expressed as a fraction of total resources
 available, derived from the latest sample or measurement.
        map<string, double> utilization = 5 [(.validate.rules) = { ... }

      • getUtilizationOrDefault

        double getUtilizationOrDefault​(java.lang.String key,
                               double defaultValue)
         Resource utilization values. Each value is expressed as a fraction of total resources
 available, derived from the latest sample or measurement.
        map<string, double> utilization = 5 [(.validate.rules) = { ... }

      • getUtilizationOrThrow

        double getUtilizationOrThrow​(java.lang.String key)
         Resource utilization values. Each value is expressed as a fraction of total resources
 available, derived from the latest sample or measurement.
        map<string, double> utilization = 5 [(.validate.rules) = { ... }

      • getRpsFractional

        double getRpsFractional()
         Total RPS being served by an endpoint. This should cover all services that an endpoint is
 responsible for.
        double rps_fractional = 6 [(.validate.rules) = { ... }
        Returns:
        The rpsFractional.

      • getEps

        double getEps()
         Total EPS (errors/second) being served by an endpoint. This should cover
 all services that an endpoint is responsible for.
        double eps = 7 [(.validate.rules) = { ... }
        Returns:
        The eps.

      • getNamedMetricsCount

        int getNamedMetricsCount()
         Application specific opaque metrics.
        map<string, double> named_metrics = 8;

      • containsNamedMetrics

        boolean containsNamedMetrics​(java.lang.String key)
         Application specific opaque metrics.
        map<string, double> named_metrics = 8;

      • getNamedMetrics

        @Deprecated
java.util.Map<java.lang.String,​java.lang.Double> getNamedMetrics()
        Deprecated.
        Use getNamedMetricsMap() instead.

      • getNamedMetricsMap

        java.util.Map<java.lang.String,​java.lang.Double> getNamedMetricsMap()
         Application specific opaque metrics.
        map<string, double> named_metrics = 8;

      • getNamedMetricsOrDefault

        double getNamedMetricsOrDefault​(java.lang.String key,
                                double defaultValue)
         Application specific opaque metrics.
        map<string, double> named_metrics = 8;

      • getNamedMetricsOrThrow

        double getNamedMetricsOrThrow​(java.lang.String key)
         Application specific opaque metrics.
        map<string, double> named_metrics = 8;

      • getApplicationUtilization

        double getApplicationUtilization()
         Application specific utilization expressed as a fraction of available
 resources. For example, an application may report the max of CPU and memory
 utilization for better load balancing if it is both CPU and memory bound.
 This should be derived from the latest sample or measurement.
 The value may be larger than 1.0 when the usage exceeds the reporter
 dependent notion of soft limits.
        double application_utilization = 9 [(.validate.rules) = { ... }
        Returns:
        The applicationUtilization.