io.opencensus.metrics.export

Class Metric

java.lang.Object

io.opencensus.metrics.export.Metric

@ExperimentalApi
 @Immutable
public abstract class Metric
extends Object

A Metric with one or more TimeSeries.

Since:

0.17

Method Summary

Modifier and Type	Method and Description
static Metric	create(MetricDescriptor metricDescriptor, List<TimeSeries> timeSeriesList) Creates a Metric.
static Metric	createWithOneTimeSeries(MetricDescriptor metricDescriptor, TimeSeries timeSeries) Creates a Metric.
abstract MetricDescriptor	getMetricDescriptor() Returns the MetricDescriptor of this metric.
abstract List<TimeSeries>	getTimeSeriesList() Returns the TimeSeries list for this metric.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Metric create(MetricDescriptor metricDescriptor,
                            List<TimeSeries> timeSeriesList)

Creates a Metric.

Parameters:

metricDescriptor - the MetricDescriptor.

timeSeriesList - the TimeSeries list for this metric.

Returns:

a Metric.

Since:

0.17

createWithOneTimeSeries

public static Metric createWithOneTimeSeries(MetricDescriptor metricDescriptor,
                                             TimeSeries timeSeries)

Creates a Metric.

Parameters:

metricDescriptor - the MetricDescriptor.

timeSeries - the single TimeSeries for this metric.

Returns:

a Metric.

Since:

0.17

getMetricDescriptor

public abstract MetricDescriptor getMetricDescriptor()

Returns the MetricDescriptor of this metric.

Returns:

the MetricDescriptor of this metric.

Since:

0.17

getTimeSeriesList

public abstract List<TimeSeries> getTimeSeriesList()

Returns the TimeSeries list for this metric.

The type of the TimeSeries.getPoints() must match MetricDescriptor.Type.

Returns:

the TimeSeriesList for this metric.

Since:

0.17