Distribution (Cloud Monitoring API v3-rev20251006-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.monitoring.v3.model.Distribution

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Distribution
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 Cloud Monitoring 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

Distribution()

Constructors
Constructor and Description
`Distribution()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Distribution`	`clone()`
`List<Long>`	`getBucketCounts()` Required in the Cloud Monitoring API v3.
`BucketOptions`	`getBucketOptions()` Required in the Cloud Monitoring API v3.
`Long`	`getCount()` The number of values in the population.
`List<Exemplar>`	`getExemplars()` Must be in increasing order of value field.
`Double`	`getMean()` The arithmetic mean of the values in the population.
`Range`	`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.
`Distribution`	`set(String fieldName, Object value)`
`Distribution`	`setBucketCounts(List<Long> bucketCounts)` Required in the Cloud Monitoring API v3.
`Distribution`	`setBucketOptions(BucketOptions bucketOptions)` Required in the Cloud Monitoring API v3.
`Distribution`	`setCount(Long count)` The number of values in the population.
`Distribution`	`setExemplars(List<Exemplar> exemplars)` Must be in increasing order of value field.
`Distribution`	`setMean(Double mean)` The arithmetic mean of the values in the population.
`Distribution`	`setRange(Range range)` If specified, contains the range of the population values.
`Distribution`	`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
  - Distribution
```
public Distribution()
```
- Method Detail
  - getBucketCounts
```
public List<Long> getBucketCounts()
```
    Required in the Cloud Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.
    
    Returns:
    
    value or null for none
  - setBucketCounts
```
public Distribution setBucketCounts(List<Long> bucketCounts)
```
    Required in the Cloud Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.
    
    Parameters:
    
    bucketCounts - bucketCounts or null for none
  - getBucketOptions
```
public BucketOptions getBucketOptions()
```
    Required in the Cloud Monitoring API v3. Defines the histogram bucket boundaries.
    
    Returns:
    
    value or null for none
  - setBucketOptions
```
public Distribution setBucketOptions(BucketOptions bucketOptions)
```
    Required in the Cloud Monitoring API v3. Defines the histogram bucket boundaries.
    
    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 Distribution 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<Exemplar> getExemplars()
```
    Must be in increasing order of value field.
    
    Returns:
    
    value or null for none
  - setExemplars
```
public Distribution setExemplars(List<Exemplar> 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 Distribution 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 Range getRange()
```
    If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Cloud Monitoring API v3.
    
    Returns:
    
    value or null for none
  - setRange
```
public Distribution setRange(Range range)
```
    If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Cloud Monitoring API v3.
    
    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 Distribution 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 Distribution set(String fieldName,
                        Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Distribution clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Distribution

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

Distribution

Method Detail

getBucketCounts

setBucketCounts

getBucketOptions

setBucketOptions

getCount

setCount

getExemplars

setExemplars

getMean

setMean

getRange

setRange

getSumOfSquaredDeviation

setSumOfSquaredDeviation

set

clone