/*
* Copyright 2020 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/servicecontrol/v1/distribution.proto
package com.google.api.servicecontrol.v1;
public interface DistributionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.api.servicecontrol.v1.Distribution)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The total number of samples in the distribution. Must be >= 0.
*
*
* int64 count = 1;
*
* @return The count.
*/
long getCount();
/**
*
*
*
* The arithmetic mean of the samples in the distribution. If `count` is
* zero then this field must be zero.
*
*
* double mean = 2;
*
* @return The mean.
*/
double getMean();
/**
*
*
*
* The minimum of the population of values. Ignored if `count` is zero.
*
*
* double minimum = 3;
*
* @return The minimum.
*/
double getMinimum();
/**
*
*
*
* The maximum of the population of values. Ignored if `count` is zero.
*
*
* double maximum = 4;
*
* @return The maximum.
*/
double getMaximum();
/**
*
*
*
* 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;
*
* @return The sumOfSquaredDeviation.
*/
double getSumOfSquaredDeviation();
/**
*
*
*
* 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;
*
* @return A list containing the bucketCounts.
*/
java.util.List 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;
*
* @return The count of bucketCounts.
*/
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;
*
* @param index The index of the element to return.
* @return The bucketCounts at the given index.
*/
long getBucketCounts(int index);
/**
*
*
*
* Buckets with constant width.
*
*
* .google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;
*
* @return Whether the linearBuckets field is set.
*/
boolean hasLinearBuckets();
/**
*
*
*
* Buckets with constant width.
*
*
* .google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;
*
* @return The linearBuckets.
*/
com.google.api.servicecontrol.v1.Distribution.LinearBuckets getLinearBuckets();
/**
*
*
*
* Buckets with constant width.
*
*
* .google.api.servicecontrol.v1.Distribution.LinearBuckets linear_buckets = 7;
*/
com.google.api.servicecontrol.v1.Distribution.LinearBucketsOrBuilder getLinearBucketsOrBuilder();
/**
*
*
*
* Buckets with exponentially growing width.
*
*
* .google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;
*
*
* @return Whether the exponentialBuckets field is set.
*/
boolean hasExponentialBuckets();
/**
*
*
*
* Buckets with exponentially growing width.
*
*
* .google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;
*
*
* @return The exponentialBuckets.
*/
com.google.api.servicecontrol.v1.Distribution.ExponentialBuckets getExponentialBuckets();
/**
*
*
*
* Buckets with exponentially growing width.
*
*
* .google.api.servicecontrol.v1.Distribution.ExponentialBuckets exponential_buckets = 8;
*
*/
com.google.api.servicecontrol.v1.Distribution.ExponentialBucketsOrBuilder
getExponentialBucketsOrBuilder();
/**
*
*
*
* Buckets with arbitrary user-provided width.
*
*
* .google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;
*
* @return Whether the explicitBuckets field is set.
*/
boolean hasExplicitBuckets();
/**
*
*
*
* Buckets with arbitrary user-provided width.
*
*
* .google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;
*
* @return The explicitBuckets.
*/
com.google.api.servicecontrol.v1.Distribution.ExplicitBuckets getExplicitBuckets();
/**
*
*
*
* Buckets with arbitrary user-provided width.
*
*
* .google.api.servicecontrol.v1.Distribution.ExplicitBuckets explicit_buckets = 9;
*/
com.google.api.servicecontrol.v1.Distribution.ExplicitBucketsOrBuilder
getExplicitBucketsOrBuilder();
/**
*
*
*
* Example points. Must be in increasing order of `value` field.
*
*
* repeated .google.api.Distribution.Exemplar exemplars = 10;
*/
java.util.List getExemplarsList();
/**
*
*
*
* Example points. Must be in increasing order of `value` field.
*
*
* repeated .google.api.Distribution.Exemplar exemplars = 10;
*/
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;
*/
int getExemplarsCount();
/**
*
*
*
* Example points. Must be in increasing order of `value` field.
*
*
* repeated .google.api.Distribution.Exemplar exemplars = 10;
*/
java.util.List
getExemplarsOrBuilderList();
/**
*
*
*
* Example points. Must be in increasing order of `value` field.
*
*
* repeated .google.api.Distribution.Exemplar exemplars = 10;
*/
com.google.api.Distribution.ExemplarOrBuilder getExemplarsOrBuilder(int index);
public com.google.api.servicecontrol.v1.Distribution.BucketOptionCase getBucketOptionCase();
}