com.google.api.control.aggregator

Class ReportRequestAggregator

java.lang.Object

com.google.api.control.aggregator.ReportRequestAggregator

public class ReportRequestAggregator
extends java.lang.Object

A container that aggregates service control ReportRequests. Thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_OPERATION_COUNT The maximum number of operations to send in a report request.
static int	NON_CACHING The flush interval returned by getFlushIntervalMillis() when an instance is configured to be non-caching.

Constructor Summary

Constructors

Constructor and Description
ReportRequestAggregator(java.lang.String serviceName, ReportAggregationOptions options) Constructor.
ReportRequestAggregator(java.lang.String serviceName, ReportAggregationOptions options, java.util.Map<java.lang.String,com.google.api.MetricDescriptor.MetricKind> kinds) Constructor.
ReportRequestAggregator(java.lang.String serviceName, ReportAggregationOptions options, java.util.Map<java.lang.String,com.google.api.MetricDescriptor.MetricKind> kinds, com.google.common.base.Ticker ticker) Constructor.

Method Summary

Modifier and Type	Method and Description
com.google.api.servicecontrol.v1.ReportRequest[]	clear() Clears this instances cache of aggregated operations.
com.google.api.servicecontrol.v1.ReportRequest[]	flush() Flushes this instance's cache.
protected com.google.api.servicecontrol.v1.ReportRequest[]	generatedFlushRequests(java.lang.Iterable<OperationAggregator> aggregators)
int	getFlushIntervalMillis()
java.lang.String	getServiceName()
boolean	report(com.google.api.servicecontrol.v1.ReportRequest req) Adds a report request to this instance's cache.

Methods inherited from class java.lang.Object

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

Field Detail

NON_CACHING

public static final int NON_CACHING

The flush interval returned by getFlushIntervalMillis() when an instance is configured to be non-caching.

See Also:

Constant Field Values

MAX_OPERATION_COUNT

public static final int MAX_OPERATION_COUNT

The maximum number of operations to send in a report request.

See Also:

Constant Field Values

Constructor Detail

ReportRequestAggregator

public ReportRequestAggregator(java.lang.String serviceName,
                               ReportAggregationOptions options,
                               @Nullable
                               java.util.Map<java.lang.String,com.google.api.MetricDescriptor.MetricKind> kinds,
                               @Nullable
                               com.google.common.base.Ticker ticker)

Constructor.

Parameters:

serviceName - the service whose ReportRequests are being aggregated

options - configures this instance's caching behavior

kinds - specifies the MetricDescriptor.MetricKind for specific metric names

ticker - the time source used to determine expiration. When not specified, this defaults to Ticker.systemTicker()

ReportRequestAggregator

public ReportRequestAggregator(java.lang.String serviceName,
                               ReportAggregationOptions options,
                               @Nullable
                               java.util.Map<java.lang.String,com.google.api.MetricDescriptor.MetricKind> kinds)

Constructor.

Parameters:

serviceName - the service whose ReportRequests are being aggregated

options - configures this instances caching behavior

kinds - specifies the MetricDescriptor.MetricKind for specific metric names

ReportRequestAggregator

public ReportRequestAggregator(java.lang.String serviceName,
                               ReportAggregationOptions options)

Constructor.

Parameters:

serviceName - the service whose ReportRequests are being aggregated

options - configures this instances caching behavior

Method Detail

getFlushIntervalMillis

public int getFlushIntervalMillis()

Returns:

the interval in milliseconds between calls to flush()

getServiceName

public java.lang.String getServiceName()

Returns:

the service whose ReportRequests are being aggregated

clear

public com.google.api.servicecontrol.v1.ReportRequest[] clear()

Clears this instances cache of aggregated operations. Is intended to be called by the driver before shutdown.

Returns:

the remaining aggregated {code ReportRequest}s

flush

public com.google.api.servicecontrol.v1.ReportRequest[] flush()

Flushes this instance's cache. The instance's driver should call the this method every getFlushIntervalMillis() milliseconds, and send the results to the report service.

Returns:

ReportRequest[] corresponding to the operations aggregated from calls to report(com.google.api.servicecontrol.v1.ReportRequest)

report

public boolean report(com.google.api.servicecontrol.v1.ReportRequest req)

Adds a report request to this instance's cache.

Parameters:

req - a ReportRequest to cache in this instance.

Returns:

true if req was cached successfully, otherwise false

generatedFlushRequests

protected com.google.api.servicecontrol.v1.ReportRequest[] generatedFlushRequests(java.lang.Iterable<OperationAggregator> aggregators)