com.google.instrumentation.stats

Class ViewDescriptor

java.lang.Object

com.google.instrumentation.stats.ViewDescriptor

Direct Known Subclasses:

ViewDescriptor.DistributionViewDescriptor, ViewDescriptor.IntervalViewDescriptor

public abstract class ViewDescriptor
extends Object

A ViewDescriptor specifies an aggregation and a set of tag keys. The aggregation will be broken down by the unique set of matching tag values for each measurement.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ViewDescriptor.DistributionViewDescriptor A ViewDescriptor for distribution-base aggregations.
static class	ViewDescriptor.IntervalViewDescriptor A ViewDescriptor for interval-based aggregations.

Method Summary

Modifier and Type	Method and Description
String	getDescription() More detailed description, for documentation purposes.
MeasurementDescriptor	getMeasurementDescriptor() Measurement type of this view.
String	getName() Name of view.
List<TagKey>	getTagKeys() Tag keys to match with the associated MeasurementDescriptor.
abstract <T> T	match(Function<ViewDescriptor.DistributionViewDescriptor,T> p0, Function<ViewDescriptor.IntervalViewDescriptor,T> p1) Applies the given match function to the underlying data type.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public final String getName()

Name of view. Must be unique.

getDescription

public final String getDescription()

More detailed description, for documentation purposes.

getMeasurementDescriptor

public final MeasurementDescriptor getMeasurementDescriptor()

Measurement type of this view.

getTagKeys

public final List<TagKey> getTagKeys()

Tag keys to match with the associated MeasurementDescriptor. If no keys are specified, then all stats are recorded. Keys must be unique.

Note: The returned list is unmodifiable, attempts to update it will throw an UnsupportedOperationException.

match

public abstract <T> T match(Function<ViewDescriptor.DistributionViewDescriptor,T> p0,
                            Function<ViewDescriptor.IntervalViewDescriptor,T> p1)

Applies the given match function to the underlying data type.