com.google.api.control.aggregator

Class ReportAggregationOptions

java.lang.Object

com.google.api.control.aggregator.ReportAggregationOptions

public class ReportAggregationOptions
extends java.lang.Object

Holds values used to configure report aggregation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FLUSH_CACHE_ENTRY_INTERVAL_MILLIS The default flush cache entry interval
static int	DEFAULT_NUM_ENTRIES The default aggregation cache size.

Constructor Summary

Constructors

Constructor and Description
ReportAggregationOptions() No-arg constructor Creates an instance initialized with the default values.
ReportAggregationOptions(int numEntries, int flushCacheEntryIntervalMillis) Constructor

Method Summary

Modifier and Type	Method and Description
<T> com.google.common.cache.Cache<java.lang.String,T>	createCache(java.util.concurrent.ConcurrentLinkedDeque<T> out) Creates a Cache configured by this instance.
<T> com.google.common.cache.Cache<java.lang.String,T>	createCache(java.util.concurrent.ConcurrentLinkedDeque<T> out, com.google.common.base.Ticker ticker) Creates a Cache configured by this instance.
int	getFlushCacheEntryIntervalMillis()
int	getNumEntries()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_NUM_ENTRIES

public static final int DEFAULT_NUM_ENTRIES

The default aggregation cache size.

See Also:

Constant Field Values

DEFAULT_FLUSH_CACHE_ENTRY_INTERVAL_MILLIS

public static final int DEFAULT_FLUSH_CACHE_ENTRY_INTERVAL_MILLIS

The default flush cache entry interval

See Also:

Constant Field Values

Constructor Detail

ReportAggregationOptions

public ReportAggregationOptions(int numEntries,
                                int flushCacheEntryIntervalMillis)

Constructor

Parameters:

numEntries - is the maximum number of cache entries that can be kept in the aggregation cache. The cache is disabled if this value is negative.

flushCacheEntryIntervalMillis - the maximum interval before aggregated report requests are flushed to the server. The cache entry is deleted after the flush

ReportAggregationOptions

public ReportAggregationOptions()

No-arg constructor Creates an instance initialized with the default values.

Method Detail

getNumEntries

public int getNumEntries()

Returns:

the maximum number of cache entries that can be kept in the aggregation cache.

getFlushCacheEntryIntervalMillis

public int getFlushCacheEntryIntervalMillis()

Returns:

the maximum interval before aggregated report requests are flushed to the server

createCache

@Nullable
public <T> com.google.common.cache.Cache<java.lang.String,T> createCache(java.util.concurrent.ConcurrentLinkedDeque<T> out)

Creates a Cache configured by this instance.

Type Parameters:

T - the type of object cached

Parameters:

out - a concurrent Deque to which previously cached values are added as they expire

Returns:

a Cache corresponding to this instance's values or null unless numEntries is positive.

createCache

@Nullable
public <T> com.google.common.cache.Cache<java.lang.String,T> createCache(java.util.concurrent.ConcurrentLinkedDeque<T> out,
                                                                                   com.google.common.base.Ticker ticker)

Creates a Cache configured by this instance.

Type Parameters:

T - the type of the value stored in the Cache

Parameters:

out - a concurrent Deque to which cached values are added as they are removed from the cache

ticker - the time source used to determine expiration

Returns:

a Cache corresponding to this instance's values or null unless #numEntries is positive.