Class Distribution

  • All Implemented Interfaces:
    DistributionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Distribution
    extends com.google.protobuf.GeneratedMessageV3
    implements DistributionOrBuilder
     Distribution represents a frequency distribution of double-valued sample
     points. It contains the size of the population of sample points plus
     additional optional information:
    
     * the arithmetic mean of the samples
     * the minimum and maximum of the samples
     * the sum-squared-deviation of the samples, used to compute variance
     * a histogram of the values of the sample points
     
    Protobuf type google.api.servicecontrol.v1.Distribution
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

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

        public long getCount()
         The total number of samples in the distribution. Must be >= 0.
         
        int64 count = 1;
        Specified by:
        getCount in interface DistributionOrBuilder
        Returns:
        The count.
      • getMean

        public double getMean()
         The arithmetic mean of the samples in the distribution. If `count` is
         zero then this field must be zero.
         
        double mean = 2;
        Specified by:
        getMean in interface DistributionOrBuilder
        Returns:
        The mean.
      • getMinimum

        public double getMinimum()
         The minimum of the population of values. Ignored if `count` is zero.
         
        double minimum = 3;
        Specified by:
        getMinimum in interface DistributionOrBuilder
        Returns:
        The minimum.
      • getMaximum

        public double getMaximum()
         The maximum of the population of values. Ignored if `count` is zero.
         
        double maximum = 4;
        Specified by:
        getMaximum in interface DistributionOrBuilder
        Returns:
        The maximum.
      • getSumOfSquaredDeviation

        public double getSumOfSquaredDeviation()
         The sum of squared deviations from the mean:
           Sum[i=1..count]((x_i - mean)^2)
         where each x_i is a sample values. If `count` is zero then this field
         must be zero, otherwise validation of the request fails.
         
        double sum_of_squared_deviation = 5;
        Specified by:
        getSumOfSquaredDeviation in interface DistributionOrBuilder
        Returns:
        The sumOfSquaredDeviation.
      • getBucketCountsList

        public List<Long> getBucketCountsList()
         The number of samples in each histogram bucket. `bucket_counts` are
         optional. If present, they must sum to the `count` value.
        
         The buckets are defined below in `bucket_option`. There are N buckets.
         `bucket_counts[0]` is the number of samples in the underflow bucket.
         `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
         in each of the finite buckets. And `bucket_counts[N] is the number
         of samples in the overflow bucket. See the comments of `bucket_option`
         below for more details.
        
         Any suffix of trailing zeros may be omitted.
         
        repeated int64 bucket_counts = 6;
        Specified by:
        getBucketCountsList in interface DistributionOrBuilder
        Returns:
        A list containing the bucketCounts.
      • getBucketCountsCount

        public int getBucketCountsCount()
         The number of samples in each histogram bucket. `bucket_counts` are
         optional. If present, they must sum to the `count` value.
        
         The buckets are defined below in `bucket_option`. There are N buckets.
         `bucket_counts[0]` is the number of samples in the underflow bucket.
         `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
         in each of the finite buckets. And `bucket_counts[N] is the number
         of samples in the overflow bucket. See the comments of `bucket_option`
         below for more details.
        
         Any suffix of trailing zeros may be omitted.
         
        repeated int64 bucket_counts = 6;
        Specified by:
        getBucketCountsCount in interface DistributionOrBuilder
        Returns:
        The count of bucketCounts.
      • getBucketCounts

        public long getBucketCounts​(int index)
         The number of samples in each histogram bucket. `bucket_counts` are
         optional. If present, they must sum to the `count` value.
        
         The buckets are defined below in `bucket_option`. There are N buckets.
         `bucket_counts[0]` is the number of samples in the underflow bucket.
         `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples
         in each of the finite buckets. And `bucket_counts[N] is the number
         of samples in the overflow bucket. See the comments of `bucket_option`
         below for more details.
        
         Any suffix of trailing zeros may be omitted.
         
        repeated int64 bucket_counts = 6;
        Specified by:
        getBucketCounts in interface DistributionOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The bucketCounts at the given index.
      • hasLinearBuckets

        public boolean hasLinearBuckets()
         Buckets with constant width.
         
        .google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;
        Specified by:
        hasLinearBuckets in interface DistributionOrBuilder
        Returns:
        Whether the linearBuckets field is set.
      • hasExponentialBuckets

        public boolean hasExponentialBuckets()
         Buckets with exponentially growing width.
         
        .google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;
        Specified by:
        hasExponentialBuckets in interface DistributionOrBuilder
        Returns:
        Whether the exponentialBuckets field is set.
      • hasExplicitBuckets

        public boolean hasExplicitBuckets()
         Buckets with arbitrary user-provided width.
         
        .google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;
        Specified by:
        hasExplicitBuckets in interface DistributionOrBuilder
        Returns:
        Whether the explicitBuckets field is set.
      • getExemplarsList

        public List<com.google.api.Distribution.Exemplar> getExemplarsList()
         Example points. Must be in increasing order of `value` field.
         
        repeated .google.api.Distribution.Exemplar exemplars = 10;
        Specified by:
        getExemplarsList in interface DistributionOrBuilder
      • getExemplarsOrBuilderList

        public List<? extends com.google.api.Distribution.ExemplarOrBuilder> getExemplarsOrBuilderList()
         Example points. Must be in increasing order of `value` field.
         
        repeated .google.api.Distribution.Exemplar exemplars = 10;
        Specified by:
        getExemplarsOrBuilderList in interface DistributionOrBuilder
      • getExemplarsCount

        public int getExemplarsCount()
         Example points. Must be in increasing order of `value` field.
         
        repeated .google.api.Distribution.Exemplar exemplars = 10;
        Specified by:
        getExemplarsCount in interface DistributionOrBuilder
      • getExemplars

        public com.google.api.Distribution.Exemplar getExemplars​(int index)
         Example points. Must be in increasing order of `value` field.
         
        repeated .google.api.Distribution.Exemplar exemplars = 10;
        Specified by:
        getExemplars in interface DistributionOrBuilder
      • getExemplarsOrBuilder

        public com.google.api.Distribution.ExemplarOrBuilder getExemplarsOrBuilder​(int index)
         Example points. Must be in increasing order of `value` field.
         
        repeated .google.api.Distribution.Exemplar exemplars = 10;
        Specified by:
        getExemplarsOrBuilder in interface DistributionOrBuilder
      • 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 Distribution parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static Distribution getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Distribution> parser()
      • getParserForType

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