Package io.opencensus.metrics.export
Class Metric
- java.lang.Object
-
- io.opencensus.metrics.export.Metric
-
- Direct Known Subclasses:
AutoValue_Metric
@ExperimentalApi @Immutable public abstract class Metric extends java.lang.Object
AMetric
with one or moreTimeSeries
.- Since:
- 0.17
-
-
Constructor Summary
Constructors Constructor Description Metric()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description private static void
checkTypeMatch(MetricDescriptor.Type type, java.util.List<TimeSeries> timeSeriesList)
static Metric
create(MetricDescriptor metricDescriptor, java.util.List<TimeSeries> timeSeriesList)
Creates aMetric
.private static Metric
createInternal(MetricDescriptor metricDescriptor, java.util.List<TimeSeries> timeSeriesList)
Creates aMetric
.static Metric
createWithOneTimeSeries(MetricDescriptor metricDescriptor, TimeSeries timeSeries)
Creates aMetric
.abstract MetricDescriptor
getMetricDescriptor()
Returns theMetricDescriptor
of this metric.abstract java.util.List<TimeSeries>
getTimeSeriesList()
Returns theTimeSeries
list for this metric.
-
-
-
Method Detail
-
create
public static Metric create(MetricDescriptor metricDescriptor, java.util.List<TimeSeries> timeSeriesList)
Creates aMetric
.- Parameters:
metricDescriptor
- theMetricDescriptor
.timeSeriesList
- theTimeSeries
list for this metric.- Returns:
- a
Metric
. - Since:
- 0.17
-
createWithOneTimeSeries
public static Metric createWithOneTimeSeries(MetricDescriptor metricDescriptor, TimeSeries timeSeries)
Creates aMetric
.- Parameters:
metricDescriptor
- theMetricDescriptor
.timeSeries
- the singleTimeSeries
for this metric.- Returns:
- a
Metric
. - Since:
- 0.17
-
createInternal
private static Metric createInternal(MetricDescriptor metricDescriptor, java.util.List<TimeSeries> timeSeriesList)
Creates aMetric
.- Parameters:
metricDescriptor
- theMetricDescriptor
.timeSeriesList
- theTimeSeries
list for this metric.- Returns:
- a
Metric
. - Since:
- 0.17
-
getMetricDescriptor
public abstract MetricDescriptor getMetricDescriptor()
Returns theMetricDescriptor
of this metric.- Returns:
- the
MetricDescriptor
of this metric. - Since:
- 0.17
-
getTimeSeriesList
public abstract java.util.List<TimeSeries> getTimeSeriesList()
Returns theTimeSeries
list for this metric.The type of the
TimeSeries.getPoints()
must matchMetricDescriptor.Type
.- Returns:
- the
TimeSeriesList
for this metric. - Since:
- 0.17
-
checkTypeMatch
private static void checkTypeMatch(MetricDescriptor.Type type, java.util.List<TimeSeries> timeSeriesList)
-
-