target.apidocs.com.google.api.services.dataflow.model.Histogram.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dataflow Show documentation

There is a newer version: v1b4-rev7-1.20.0

Show newest version







Histogram (Dataflow API v1b3-rev20231112-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dataflow.model
Class Histogram



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.dataflow.model.Histogram













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class Histogram
extends com.google.api.client.json.GenericJson
Histogram of value counts for a distribution. Buckets have an inclusive lower bound and exclusive
 upper bound and use "1,2,5 bucketing": The first bucket range is from [0,1) and all subsequent
 bucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket boundaries are 0, 1,
 2, 5, 10, 20, 50, 100, 200, 500, 1000, ... Negative values are not supported.

  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 Dataflow 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


Histogram() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Histogram
clone() 


List<Long>
getBucketCounts()
Counts of values in each bucket.



Integer
getFirstBucketOffset()
Starting index of first stored bucket.



Histogram
set(String fieldName,
   Object value) 


Histogram
setBucketCounts(List<Long> bucketCounts)
Counts of values in each bucket.



Histogram
setFirstBucketOffset(Integer firstBucketOffset)
Starting index of first stored bucket.







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





Histogram
public Histogram()









Method Detail





getBucketCounts
public List<Long> getBucketCounts()
Counts of values in each bucket. For efficiency, prefix and trailing buckets with count = 0 are
 elided. Buckets can store the full range of values of an unsigned long, with ULLONG_MAX falling
 into the 59th bucket with range [1e19, 2e19).

Returns:
value or null for none








setBucketCounts
public Histogram setBucketCounts(List<Long> bucketCounts)
Counts of values in each bucket. For efficiency, prefix and trailing buckets with count = 0 are
 elided. Buckets can store the full range of values of an unsigned long, with ULLONG_MAX falling
 into the 59th bucket with range [1e19, 2e19).

Parameters:
bucketCounts - bucketCounts or null for none








getFirstBucketOffset
public Integer getFirstBucketOffset()
Starting index of first stored bucket. The non-inclusive upper-bound of the ith bucket is given
 by: pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3]

Returns:
value or null for none








setFirstBucketOffset
public Histogram setFirstBucketOffset(Integer firstBucketOffset)
Starting index of first stored bucket. The non-inclusive upper-bound of the ith bucket is given
 by: pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3]

Parameters:
firstBucketOffset - firstBucketOffset or null for none








set
public Histogram set(String fieldName,
                     Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public Histogram clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.

Modifier and Type	Method and Description
`Histogram`	`clone()`
`List<Long>`	`getBucketCounts()` Counts of values in each bucket.
`Integer`	`getFirstBucketOffset()` Starting index of first stored bucket.
`Histogram`	`set(String fieldName, Object value)`
`Histogram`	`setBucketCounts(List<Long> bucketCounts)` Counts of values in each bucket.
`Histogram`	`setFirstBucketOffset(Integer firstBucketOffset)` Starting index of first stored bucket.