alluxio.metrics

Class MetricKey.Builder

java.lang.Object

alluxio.metrics.MetricKey.Builder

Enclosing class:

MetricKey

public static final class MetricKey.Builder
extends Object

Builder to create MetricKey instances. Note that, Builder.build() will throw exception if there is an existing Metric built with the same name.

Constructor Summary

Constructors

Constructor and Description
Builder(String name)

Method Summary

Modifier and Type	Method and Description
MetricKey	build() Creates and registers the Metric key.
MetricKey.Builder	setDescription(String description)
MetricKey.Builder	setIsClusterAggregated(boolean isClusterAggregated)
MetricKey.Builder	setMetricType(MetricType metricType)
MetricKey.Builder	setName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String name)

Parameters:

name - name of the Metric

Method Detail

setName

public MetricKey.Builder setName(String name)

Parameters:

name - name for the Metric

Returns:

the updated builder instance

setDescription

public MetricKey.Builder setDescription(String description)

Parameters:

description - of the Metric

Returns:

the updated builder instance

setIsClusterAggregated

public MetricKey.Builder setIsClusterAggregated(boolean isClusterAggregated)

Parameters:

isClusterAggregated - whether this metric can be aggregated at cluster level

Returns:

the updated builder instance

setMetricType

public MetricKey.Builder setMetricType(MetricType metricType)

Parameters:

metricType - the metric type of this metric

Returns:

the updated builder instance

build

public MetricKey build()

Creates and registers the Metric key.

Returns:

the created Metric key instance