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

Class OrcaLoadReport

  • All Implemented Interfaces:
    OrcaLoadReportOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class OrcaLoadReport
extends com.google.protobuf.GeneratedMessageV3
implements OrcaLoadReportOrBuilder
    Protobuf type xds.data.orca.v3.OrcaLoadReport
    See Also:
    Serialized Form

    • Field Detail

      • CPU_UTILIZATION_FIELD_NUMBER

        public static final int CPU_UTILIZATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MEM_UTILIZATION_FIELD_NUMBER

        public static final int MEM_UTILIZATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_COST_FIELD_NUMBER

        public static final int REQUEST_COST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UTILIZATION_FIELD_NUMBER

        public static final int UTILIZATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RPS_FRACTIONAL_FIELD_NUMBER

        public static final int RPS_FRACTIONAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NAMED_METRICS_FIELD_NUMBER

        public static final int NAMED_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • APPLICATION_UTILIZATION_FIELD_NUMBER

        public static final int APPLICATION_UTILIZATION_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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getCpuUtilization

        public 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) = { ... }
        Specified by:
        getCpuUtilization in interface OrcaLoadReportOrBuilder
        Returns:
        The cpuUtilization.

      • getMemUtilization

        public 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) = { ... }
        Specified by:
        getMemUtilization in interface OrcaLoadReportOrBuilder
        Returns:
        The memUtilization.

      • getRps

        @Deprecated
public 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];
        Specified by:
        getRps in interface OrcaLoadReportOrBuilder
        Returns:
        The rps.

      • getRequestCostCount

        public int getRequestCostCount()
        Description copied from interface: OrcaLoadReportOrBuilder
         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;
        Specified by:
        getRequestCostCount in interface OrcaLoadReportOrBuilder

      • containsRequestCost

        public boolean containsRequestCost​(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;
        Specified by:
        containsRequestCost in interface OrcaLoadReportOrBuilder

      • getRequestCostMap

        public Map<String,​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;
        Specified by:
        getRequestCostMap in interface OrcaLoadReportOrBuilder

      • getRequestCostOrDefault

        public double getRequestCostOrDefault​(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;
        Specified by:
        getRequestCostOrDefault in interface OrcaLoadReportOrBuilder

      • getRequestCostOrThrow

        public double getRequestCostOrThrow​(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;
        Specified by:
        getRequestCostOrThrow in interface OrcaLoadReportOrBuilder

      • getUtilizationCount

        public int getUtilizationCount()
        Description copied from interface: OrcaLoadReportOrBuilder
         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) = { ... }
        Specified by:
        getUtilizationCount in interface OrcaLoadReportOrBuilder

      • containsUtilization

        public boolean containsUtilization​(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) = { ... }
        Specified by:
        containsUtilization in interface OrcaLoadReportOrBuilder

      • getUtilizationMap

        public Map<String,​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) = { ... }
        Specified by:
        getUtilizationMap in interface OrcaLoadReportOrBuilder

      • getUtilizationOrDefault

        public double getUtilizationOrDefault​(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) = { ... }
        Specified by:
        getUtilizationOrDefault in interface OrcaLoadReportOrBuilder

      • getUtilizationOrThrow

        public double getUtilizationOrThrow​(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) = { ... }
        Specified by:
        getUtilizationOrThrow in interface OrcaLoadReportOrBuilder

      • getRpsFractional

        public 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) = { ... }
        Specified by:
        getRpsFractional in interface OrcaLoadReportOrBuilder
        Returns:
        The rpsFractional.

      • getEps

        public 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) = { ... }
        Specified by:
        getEps in interface OrcaLoadReportOrBuilder
        Returns:
        The eps.

      • getApplicationUtilization

        public 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) = { ... }
        Specified by:
        getApplicationUtilization in interface OrcaLoadReportOrBuilder
        Returns:
        The applicationUtilization.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static OrcaLoadReport getDefaultInstance()

      • parser

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

      • getParserForType

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