Package io.opencensus.stats
Class View
java.lang.Object
io.opencensus.stats.View
- Direct Known Subclasses:
AutoValue_View
A View 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 measure.
- Since:
- 0.8
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Deprecated.since 0.13.static class
The name of aView
. -
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final int
private static final Comparator
<TagKey> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic View
create
(View.Name name, String description, Measure measure, Aggregation aggregation, List<TagKey> columns) Constructs a newView
.static View
create
(View.Name name, String description, Measure measure, Aggregation aggregation, List<TagKey> columns, View.AggregationWindow window) Deprecated.in favor ofcreate(Name, String, Measure, Aggregation, List)
.abstract Aggregation
TheAggregation
associated with thisView
.Columns (a.k.a Tag Keys) to match with the associatedMeasure
.abstract String
More detailed description, for documentation purposes.abstract Measure
Measure type of this view.abstract View.Name
getName()
Name of view.abstract View.AggregationWindow
Deprecated.since 0.13.
-
Field Details
-
NAME_MAX_LENGTH
static final int NAME_MAX_LENGTH- See Also:
-
TAG_KEY_COMPARATOR
-
-
Constructor Details
-
View
View()
-
-
Method Details
-
getName
Name of view. Must be unique.- Since:
- 0.8
-
getDescription
More detailed description, for documentation purposes.- Since:
- 0.8
-
getMeasure
Measure type of this view.- Since:
- 0.8
-
getAggregation
TheAggregation
associated with thisView
.- Since:
- 0.8
-
getColumns
Columns (a.k.a Tag Keys) to match with the associatedMeasure
.Measure
will be recorded in a "greedy" way. That is, every view aggregates every measure. This is similar to doing a GROUPBY on view’s columns. Columns must be unique.- Since:
- 0.8
-
getWindow
Deprecated.since 0.13. In the future allView
s will be cumulative.Returns the timeView.AggregationWindow
for thisView
.- Returns:
- the time
View.AggregationWindow
. - Since:
- 0.8
-
create
@Deprecated public static View create(View.Name name, String description, Measure measure, Aggregation aggregation, List<TagKey> columns, View.AggregationWindow window) Deprecated.in favor ofcreate(Name, String, Measure, Aggregation, List)
.Constructs a newView
.- Parameters:
name
- theView.Name
of view. Must be unique.description
- the description of view.measure
- theMeasure
to be aggregated by this view.aggregation
- the basicAggregation
that this view will support.columns
- theTagKey
s that this view will aggregate on. Columns should not contain duplicates.window
- theView.AggregationWindow
of view.- Returns:
- a new
View
. - Since:
- 0.8
-
create
public static View create(View.Name name, String description, Measure measure, Aggregation aggregation, List<TagKey> columns) Constructs a newView
.- Parameters:
name
- theView.Name
of view. Must be unique.description
- the description of view.measure
- theMeasure
to be aggregated by this view.aggregation
- the basicAggregation
that this view will support.columns
- theTagKey
s that this view will aggregate on. Columns should not contain duplicates.- Returns:
- a new
View
. - Since:
- 0.13
-