GoogleApiDistribution (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleApiDistribution

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleApiDistribution
extends com.google.api.client.json.GenericJson
```
`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleApiDistribution()

Constructors
Constructor and Description
`GoogleApiDistribution()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleApiDistribution`	`clone()`
`List<Long>`	`getBucketCounts()` The number of values in each bucket of the histogram, as described in `bucket_options`.
`GoogleApiDistributionBucketOptions`	`getBucketOptions()` Defines the histogram bucket boundaries.
`Long`	`getCount()` The number of values in the population.
`List<GoogleApiDistributionExemplar>`	`getExemplars()` Must be in increasing order of `value` field.
`Double`	`getMean()` The arithmetic mean of the values in the population.
`GoogleApiDistributionRange`	`getRange()` If specified, contains the range of the population values.
`Double`	`getSumOfSquaredDeviation()` The sum of squared deviations from the mean of the values in the population.
`GoogleApiDistribution`	`set(String fieldName, Object value)`
`GoogleApiDistribution`	`setBucketCounts(List<Long> bucketCounts)` The number of values in each bucket of the histogram, as described in `bucket_options`.
`GoogleApiDistribution`	`setBucketOptions(GoogleApiDistributionBucketOptions bucketOptions)` Defines the histogram bucket boundaries.
`GoogleApiDistribution`	`setCount(Long count)` The number of values in the population.
`GoogleApiDistribution`	`setExemplars(List<GoogleApiDistributionExemplar> exemplars)` Must be in increasing order of `value` field.
`GoogleApiDistribution`	`setMean(Double mean)` The arithmetic mean of the values in the population.
`GoogleApiDistribution`	`setRange(GoogleApiDistributionRange range)` If specified, contains the range of the population values.
`GoogleApiDistribution`	`setSumOfSquaredDeviation(Double sumOfSquaredDeviation)` The sum of squared deviations from the mean of the values in the population.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleApiDistribution
```
public GoogleApiDistribution()
```
- Method Detail
  - getBucketCounts
```
public List<Long> getBucketCounts()
```
    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).
    
    Returns:
    
    value or null for none
  - setBucketCounts
```
public GoogleApiDistribution setBucketCounts(List<Long> bucketCounts)
```
    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).
    
    Parameters:
    
    bucketCounts - bucketCounts or null for none
  - getBucketOptions
```
public GoogleApiDistributionBucketOptions getBucketOptions()
```
    Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
    
    Returns:
    
    value or null for none
  - setBucketOptions
```
public GoogleApiDistribution setBucketOptions(GoogleApiDistributionBucketOptions bucketOptions)
```
    Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
    
    Parameters:
    
    bucketOptions - bucketOptions or null for none
  - getCount
```
public Long getCount()
```
    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.
    
    Returns:
    
    value or null for none
  - setCount
```
public GoogleApiDistribution setCount(Long count)
```
    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.
    
    Parameters:
    
    count - count or null for none
  - getExemplars
```
public List<GoogleApiDistributionExemplar> getExemplars()
```
    Must be in increasing order of `value` field.
    
    Returns:
    
    value or null for none
  - setExemplars
```
public GoogleApiDistribution setExemplars(List<GoogleApiDistributionExemplar> exemplars)
```
    Must be in increasing order of `value` field.
    
    Parameters:
    
    exemplars - exemplars or null for none
  - getMean
```
public Double getMean()
```
    The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
    
    Returns:
    
    value or null for none
  - setMean
```
public GoogleApiDistribution setMean(Double mean)
```
    The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
    
    Parameters:
    
    mean - mean or null for none
  - getRange
```
public GoogleApiDistributionRange getRange()
```
    If specified, contains the range of the population values. The field must not be present if the `count` is zero.
    
    Returns:
    
    value or null for none
  - setRange
```
public GoogleApiDistribution setRange(GoogleApiDistributionRange range)
```
    If specified, contains the range of the population values. The field must not be present if the `count` is zero.
    
    Parameters:
    
    range - range or null for none
  - getSumOfSquaredDeviation
```
public Double getSumOfSquaredDeviation()
```
    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.
    
    Returns:
    
    value or null for none
  - setSumOfSquaredDeviation
```
public GoogleApiDistribution setSumOfSquaredDeviation(Double sumOfSquaredDeviation)
```
    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.
    
    Parameters:
    
    sumOfSquaredDeviation - sumOfSquaredDeviation or null for none
  - set
```
public GoogleApiDistribution set(String fieldName,
                                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleApiDistribution clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleApiDistribution

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleApiDistribution

Method Detail

getBucketCounts

setBucketCounts

getBucketOptions

setBucketOptions

getCount

setCount

getExemplars

setExemplars

getMean

setMean

getRange

setRange

getSumOfSquaredDeviation

setSumOfSquaredDeviation

set

clone