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

Class OrcaLoadReport.Builder

  • All Implemented Interfaces:
    OrcaLoadReportOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    OrcaLoadReport
    public static final class OrcaLoadReport.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>
implements OrcaLoadReportOrBuilder
    Protobuf type xds.data.orca.v3.OrcaLoadReport

    • Method Detail

      • 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.Builder<OrcaLoadReport.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • clear

        public OrcaLoadReport.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public OrcaLoadReport.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • setField

        public OrcaLoadReport.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • clearField

        public OrcaLoadReport.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • clearOneof

        public OrcaLoadReport.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • setRepeatedField

        public OrcaLoadReport.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • addRepeatedField

        public OrcaLoadReport.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • mergeFrom

        public OrcaLoadReport.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OrcaLoadReport.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • mergeFrom

        public OrcaLoadReport.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OrcaLoadReport.Builder>
        Throws:
        IOException

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

      • setCpuUtilization

        public OrcaLoadReport.Builder setCpuUtilization​(double value)
         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) = { ... }
        Parameters:
        value - The cpuUtilization to set.
        Returns:
        This builder for chaining.

      • clearCpuUtilization

        public OrcaLoadReport.Builder clearCpuUtilization()
         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:
        This builder for chaining.

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

      • setMemUtilization

        public OrcaLoadReport.Builder setMemUtilization​(double value)
         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) = { ... }
        Parameters:
        value - The memUtilization to set.
        Returns:
        This builder for chaining.

      • clearMemUtilization

        public OrcaLoadReport.Builder clearMemUtilization()
         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:
        This builder for chaining.

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

      • setRps

        @Deprecated
public OrcaLoadReport.Builder setRps​(long value)
        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];
        Parameters:
        value - The rps to set.
        Returns:
        This builder for chaining.

      • clearRps

        @Deprecated
public OrcaLoadReport.Builder clearRps()
        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:
        This builder for chaining.

      • 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

      • removeRequestCost

        public OrcaLoadReport.Builder removeRequestCost​(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;

      • getMutableRequestCost

        @Deprecated
public Map<String,​Double> getMutableRequestCost()
        Deprecated.
        Use alternate mutation accessors instead.

      • putRequestCost

        public OrcaLoadReport.Builder putRequestCost​(String key,
                                             double value)
         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;

      • putAllRequestCost

        public OrcaLoadReport.Builder putAllRequestCost​(Map<String,​Double> values)
         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

        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

      • removeUtilization

        public OrcaLoadReport.Builder removeUtilization​(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) = { ... }

      • getMutableUtilization

        @Deprecated
public Map<String,​Double> getMutableUtilization()
        Deprecated.
        Use alternate mutation accessors instead.

      • putUtilization

        public OrcaLoadReport.Builder putUtilization​(String key,
                                             double value)
         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) = { ... }

      • putAllUtilization

        public OrcaLoadReport.Builder putAllUtilization​(Map<String,​Double> values)
         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

        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.

      • setRpsFractional

        public OrcaLoadReport.Builder setRpsFractional​(double value)
         Total RPS being served by an endpoint. This should cover all services that an endpoint is
 responsible for.
        double rps_fractional = 6 [(.validate.rules) = { ... }
        Parameters:
        value - The rpsFractional to set.
        Returns:
        This builder for chaining.

      • clearRpsFractional

        public OrcaLoadReport.Builder clearRpsFractional()
         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:
        This builder for chaining.

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

      • setEps

        public OrcaLoadReport.Builder setEps​(double value)
         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) = { ... }
        Parameters:
        value - The eps to set.
        Returns:
        This builder for chaining.

      • clearEps

        public OrcaLoadReport.Builder clearEps()
         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:
        This builder for chaining.

      • removeNamedMetrics

        public OrcaLoadReport.Builder removeNamedMetrics​(String key)
         Application specific opaque metrics.
        map<string, double> named_metrics = 8;

      • getMutableNamedMetrics

        @Deprecated
public Map<String,​Double> getMutableNamedMetrics()
        Deprecated.
        Use alternate mutation accessors instead.

      • putNamedMetrics

        public OrcaLoadReport.Builder putNamedMetrics​(String key,
                                              double value)
         Application specific opaque metrics.
        map<string, double> named_metrics = 8;

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

      • setApplicationUtilization

        public OrcaLoadReport.Builder setApplicationUtilization​(double value)
         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) = { ... }
        Parameters:
        value - The applicationUtilization to set.
        Returns:
        This builder for chaining.

      • clearApplicationUtilization

        public OrcaLoadReport.Builder clearApplicationUtilization()
         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:
        This builder for chaining.

      • setUnknownFields

        public final OrcaLoadReport.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>

      • mergeUnknownFields

        public final OrcaLoadReport.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OrcaLoadReport.Builder>