com.google.api.services.monitoring.v3.model

Class BucketOptions

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.BucketOptions

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BucketOptions
extends com.google.api.client.json.GenericJson

BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so- called because both bounds are finite.

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
BucketOptions()

Method Summary

Modifier and Type	Method and Description
BucketOptions	clone()
Explicit	getExplicitBuckets() The explicit buckets.
Exponential	getExponentialBuckets() The exponential buckets.
Linear	getLinearBuckets() The linear bucket.
BucketOptions	set(String fieldName, Object value)
BucketOptions	setExplicitBuckets(Explicit explicitBuckets) The explicit buckets.
BucketOptions	setExponentialBuckets(Exponential exponentialBuckets) The exponential buckets.
BucketOptions	setLinearBuckets(Linear linearBuckets) The linear 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

BucketOptions

public BucketOptions()

Method Detail

getExplicitBuckets

public Explicit getExplicitBuckets()

The explicit buckets.

Returns:

value or null for none

setExplicitBuckets

public BucketOptions setExplicitBuckets(Explicit explicitBuckets)

The explicit buckets.

Parameters:

explicitBuckets - explicitBuckets or null for none

getExponentialBuckets

public Exponential getExponentialBuckets()

The exponential buckets.

Returns:

value or null for none

setExponentialBuckets

public BucketOptions setExponentialBuckets(Exponential exponentialBuckets)

The exponential buckets.

Parameters:

exponentialBuckets - exponentialBuckets or null for none

getLinearBuckets

public Linear getLinearBuckets()

The linear bucket.

Returns:

value or null for none

setLinearBuckets

public BucketOptions setLinearBuckets(Linear linearBuckets)

The linear bucket.

Parameters:

linearBuckets - linearBuckets or null for none

set

public BucketOptions set(String fieldName,
                         Object value)

Overrides:

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

clone

public BucketOptions clone()

Overrides:

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