io.opencensus.metrics

Class MetricOptions.Builder

java.lang.Object

io.opencensus.metrics.MetricOptions.Builder

Enclosing class:

MetricOptions

public abstract static class MetricOptions.Builder
extends Object

Builder for MetricOptions.

Since:

0.20

Method Summary

Modifier and Type	Method and Description
MetricOptions	build() Builds and returns a MetricOptions with the desired options.
abstract MetricOptions.Builder	setConstantLabels(Map<LabelKey,LabelValue> constantLabels) Sets the map of constant labels (they will be added to all the TimeSeries) for the Metric.
abstract MetricOptions.Builder	setDescription(String description) Sets the description of the Metric.
abstract MetricOptions.Builder	setLabelKeys(List<LabelKey> labelKeys) Sets the list of label keys for the Metric.
abstract MetricOptions.Builder	setUnit(String unit) Sets the unit of the Metric.

Methods inherited from class java.lang.Object

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

Method Detail

setDescription

public abstract MetricOptions.Builder setDescription(String description)

Sets the description of the Metric.

Parameters:

description - the description of the Metric.

Returns:

this.

Since:

0.20

setUnit

public abstract MetricOptions.Builder setUnit(String unit)

Sets the unit of the Metric.

Parameters:

unit - the unit of the Metric.

Returns:

this.

Since:

0.20

setLabelKeys

public abstract MetricOptions.Builder setLabelKeys(List<LabelKey> labelKeys)

Sets the list of label keys for the Metric.

Parameters:

labelKeys - the list of label keys for the Metric.

Returns:

this.

Since:

0.20

setConstantLabels

public abstract MetricOptions.Builder setConstantLabels(Map<LabelKey,LabelValue> constantLabels)

Sets the map of constant labels (they will be added to all the TimeSeries) for the Metric.

Parameters:

constantLabels - the map of constant labels for the Metric.

Returns:

this.

Since:

0.21

build

public MetricOptions build()

Builds and returns a MetricOptions with the desired options.

Returns:

a MetricOptions with the desired options.

Throws:

NullPointerException - if description, OR unit is null, OR labelKeys is null OR any element of labelKeys is null, OR OR constantLabels is null OR any element of constantLabels is null.

IllegalArgumentException - if any LabelKey from the labelKeys is in the constantLabels.

Since:

0.20