com.google.api.DistributionOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-common-protos Show documentation
Show all versions of proto-google-common-protos Show documentation
PROTO library for proto-google-common-protos
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/distribution.proto
// Protobuf Java Version: 3.25.2
package com.google.api;
public interface DistributionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.api.Distribution)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The number of values in the population. Must be non-negative. This value
* must equal the sum of the values in `bucket_counts` if a histogram is
* provided.
*
*
* int64 count = 1;
*
* @return The count.
*/
long getCount();
/**
*
*
*
* The arithmetic mean of the values in the population. If `count` is zero
* then this field must be zero.
*
*
* double mean = 2;
*
* @return The mean.
*/
double getMean();
/**
*
*
*
* The sum of squared deviations from the mean of the values in the
* population. For values x_i this is:
*
* Sum[i=1..n]((x_i - mean)^2)
*
* Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition
* describes Welford's method for accumulating this sum in one pass.
*
* If `count` is zero then this field must be zero.
*
*
* double sum_of_squared_deviation = 3;
*
* @return The sumOfSquaredDeviation.
*/
double getSumOfSquaredDeviation();
/**
*
*
*
* If specified, contains the range of the population values. The field
* must not be present if the `count` is zero.
*
*
* .google.api.Distribution.Range range = 4;
*
* @return Whether the range field is set.
*/
boolean hasRange();
/**
*
*
*
* If specified, contains the range of the population values. The field
* must not be present if the `count` is zero.
*
*
* .google.api.Distribution.Range range = 4;
*
* @return The range.
*/
com.google.api.Distribution.Range getRange();
/**
*
*
*
* If specified, contains the range of the population values. The field
* must not be present if the `count` is zero.
*
*
* .google.api.Distribution.Range range = 4;
*/
com.google.api.Distribution.RangeOrBuilder getRangeOrBuilder();
/**
*
*
*
* Defines the histogram bucket boundaries. If the distribution does not
* contain a histogram, then omit this field.
*
*
* .google.api.Distribution.BucketOptions bucket_options = 6;
*
* @return Whether the bucketOptions field is set.
*/
boolean hasBucketOptions();
/**
*
*
*
* Defines the histogram bucket boundaries. If the distribution does not
* contain a histogram, then omit this field.
*
*
* .google.api.Distribution.BucketOptions bucket_options = 6;
*
* @return The bucketOptions.
*/
com.google.api.Distribution.BucketOptions getBucketOptions();
/**
*
*
*
* Defines the histogram bucket boundaries. If the distribution does not
* contain a histogram, then omit this field.
*
*
* .google.api.Distribution.BucketOptions bucket_options = 6;
*/
com.google.api.Distribution.BucketOptionsOrBuilder getBucketOptionsOrBuilder();
/**
*
*
*
* The number of values in each bucket of the histogram, as described in
* `bucket_options`. If the distribution does not have a histogram, then omit
* this field. If there is a histogram, then the sum of the values in
* `bucket_counts` must equal the value in the `count` field of the
* distribution.
*
* If present, `bucket_counts` should contain N values, where N is the number
* of buckets specified in `bucket_options`. If you supply fewer than N
* values, the remaining values are assumed to be 0.
*
* The order of the values in `bucket_counts` follows the bucket numbering
* schemes described for the three bucket types. The first value must be the
* count for the underflow bucket (number 0). The next N-2 values are the
* counts for the finite buckets (number 1 through N-2). The N'th value in
* `bucket_counts` is the count for the overflow bucket (number N-1).
*
*
* repeated int64 bucket_counts = 7;
*
* @return A list containing the bucketCounts.
*/
java.util.List getBucketCountsList();
/**
*
*
*
* The number of values in each bucket of the histogram, as described in
* `bucket_options`. If the distribution does not have a histogram, then omit
* this field. If there is a histogram, then the sum of the values in
* `bucket_counts` must equal the value in the `count` field of the
* distribution.
*
* If present, `bucket_counts` should contain N values, where N is the number
* of buckets specified in `bucket_options`. If you supply fewer than N
* values, the remaining values are assumed to be 0.
*
* The order of the values in `bucket_counts` follows the bucket numbering
* schemes described for the three bucket types. The first value must be the
* count for the underflow bucket (number 0). The next N-2 values are the
* counts for the finite buckets (number 1 through N-2). The N'th value in
* `bucket_counts` is the count for the overflow bucket (number N-1).
*
*
* repeated int64 bucket_counts = 7;
*
* @return The count of bucketCounts.
*/
int getBucketCountsCount();
/**
*
*
*
* The number of values in each bucket of the histogram, as described in
* `bucket_options`. If the distribution does not have a histogram, then omit
* this field. If there is a histogram, then the sum of the values in
* `bucket_counts` must equal the value in the `count` field of the
* distribution.
*
* If present, `bucket_counts` should contain N values, where N is the number
* of buckets specified in `bucket_options`. If you supply fewer than N
* values, the remaining values are assumed to be 0.
*
* The order of the values in `bucket_counts` follows the bucket numbering
* schemes described for the three bucket types. The first value must be the
* count for the underflow bucket (number 0). The next N-2 values are the
* counts for the finite buckets (number 1 through N-2). The N'th value in
* `bucket_counts` is the count for the overflow bucket (number N-1).
*
*
* repeated int64 bucket_counts = 7;
*
* @param index The index of the element to return.
* @return The bucketCounts at the given index.
*/
long getBucketCounts(int index);
/**
*
*
*
* Must be in increasing order of `value` field.
*
*
* repeated .google.api.Distribution.Exemplar exemplars = 10;
*/
java.util.List getExemplarsList();
/**
*
*
*
* Must be in increasing order of `value` field.
*
*
* repeated .google.api.Distribution.Exemplar exemplars = 10;
*/
com.google.api.Distribution.Exemplar getExemplars(int index);
/**
*
*
*
* Must be in increasing order of `value` field.
*
*
* repeated .google.api.Distribution.Exemplar exemplars = 10;
*/
int getExemplarsCount();
/**
*
*
*
* Must be in increasing order of `value` field.
*
*
* repeated .google.api.Distribution.Exemplar exemplars = 10;
*/
java.util.List
getExemplarsOrBuilderList();
/**
*
*
*
* Must be in increasing order of `value` field.
*
*
* repeated .google.api.Distribution.Exemplar exemplars = 10;
*/
com.google.api.Distribution.ExemplarOrBuilder getExemplarsOrBuilder(int index);
}