Package io.opencensus.metrics.export
Class TimeSeries
- java.lang.Object
-
- io.opencensus.metrics.export.TimeSeries
-
- Direct Known Subclasses:
AutoValue_TimeSeries
@ExperimentalApi @Immutable public abstract class TimeSeries extends java.lang.Object
A collection of data points that describes the time-varying values of aMetric
.- Since:
- 0.17
-
-
Constructor Summary
Constructors Constructor Description TimeSeries()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static TimeSeries
create(java.util.List<LabelValue> labelValues)
Creates aTimeSeries
with empty(or no) points.static TimeSeries
create(java.util.List<LabelValue> labelValues, java.util.List<Point> points, Timestamp startTimestamp)
Creates aTimeSeries
.private static TimeSeries
createInternal(java.util.List<LabelValue> labelValues, java.util.List<Point> points, Timestamp startTimestamp)
Creates aTimeSeries
.static TimeSeries
createWithOnePoint(java.util.List<LabelValue> labelValues, Point point, Timestamp startTimestamp)
Creates aTimeSeries
.abstract java.util.List<LabelValue>
getLabelValues()
Returns the set ofLabelValue
s that uniquely identify thisTimeSeries
.abstract java.util.List<Point>
getPoints()
Returns the dataPoint
s of thisTimeSeries
.abstract Timestamp
getStartTimestamp()
Returns the startTimestamp
of thisTimeSeries
if thePoint
s are cumulative, ornull
if thePoint
s are gauge.TimeSeries
setPoint(Point point)
Sets thePoint
of theTimeSeries
.
-
-
-
Method Detail
-
create
public static TimeSeries create(java.util.List<LabelValue> labelValues, java.util.List<Point> points, @Nullable Timestamp startTimestamp)
Creates aTimeSeries
.- Parameters:
labelValues
- theLabelValue
s that uniquely identify thisTimeSeries
.points
- the dataPoint
s of thisTimeSeries
.startTimestamp
- the startTimestamp
of thisTimeSeries
. Must be non-null for cumulativePoint
s.- Returns:
- a
TimeSeries
. - Since:
- 0.17
-
create
public static TimeSeries create(java.util.List<LabelValue> labelValues)
Creates aTimeSeries
with empty(or no) points.- Parameters:
labelValues
- theLabelValue
s that uniquely identify thisTimeSeries
.- Returns:
- a
TimeSeries
. - Since:
- 0.17
-
createWithOnePoint
public static TimeSeries createWithOnePoint(java.util.List<LabelValue> labelValues, Point point, @Nullable Timestamp startTimestamp)
Creates aTimeSeries
.- Parameters:
labelValues
- theLabelValue
s that uniquely identify thisTimeSeries
.point
- the single dataPoint
of thisTimeSeries
.startTimestamp
- the startTimestamp
of thisTimeSeries
. Must be non-null for cumulativePoint
s.- Returns:
- a
TimeSeries
. - Since:
- 0.17
-
setPoint
public TimeSeries setPoint(Point point)
Sets thePoint
of theTimeSeries
.- Parameters:
point
- the single dataPoint
of thisTimeSeries
.- Returns:
- a
TimeSeries
. - Since:
- 0.17
-
createInternal
private static TimeSeries createInternal(java.util.List<LabelValue> labelValues, java.util.List<Point> points, @Nullable Timestamp startTimestamp)
Creates aTimeSeries
.- Parameters:
labelValues
- theLabelValue
s that uniquely identify thisTimeSeries
.points
- the dataPoint
s of thisTimeSeries
.startTimestamp
- the startTimestamp
of thisTimeSeries
. Must be non-null for cumulativePoint
s.- Returns:
- a
TimeSeries
.
-
getLabelValues
public abstract java.util.List<LabelValue> getLabelValues()
Returns the set ofLabelValue
s that uniquely identify thisTimeSeries
.Apply to all
Point
s.The order of
LabelValue
s must match that ofLabelKey
s in theMetricDescriptor
.- Returns:
- the
LabelValue
s. - Since:
- 0.17
-
getPoints
public abstract java.util.List<Point> getPoints()
Returns the dataPoint
s of thisTimeSeries
.- Returns:
- the data
Point
s. - Since:
- 0.17
-
getStartTimestamp
@Nullable public abstract Timestamp getStartTimestamp()
Returns the startTimestamp
of thisTimeSeries
if thePoint
s are cumulative, ornull
if thePoint
s are gauge.- Returns:
- the start
Timestamp
ornull
. - Since:
- 0.17
-
-