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

A Metric with one or more TimeSeries.

Since:

0.17

Constructor Summary

Constructors

Constructor	Description
Metric()

Method Summary

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 a Metric.
private static Metric	createInternal(MetricDescriptor metricDescriptor, java.util.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 java.util.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

Constructor Detail

Metric

Metric()

Method Detail

create

public static Metric create(MetricDescriptor metricDescriptor,
                            java.util.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

createInternal

private static Metric createInternal(MetricDescriptor metricDescriptor,
                                     java.util.List<TimeSeries> timeSeriesList)

Creates a Metric.

Parameters:

metricDescriptor - the MetricDescriptor.

timeSeriesList - the TimeSeries list 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 java.util.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

checkTypeMatch

private static void checkTypeMatch(MetricDescriptor.Type type,
                                   java.util.List<TimeSeries> timeSeriesList)