org.kairosdb.client.builder

Class MetricBuilder

java.lang.Object

org.kairosdb.client.builder.MetricBuilder

public class MetricBuilder
extends Object

Builder used to create the JSON to push metrics to KairosDB.

Method Summary

Methods

Modifier and Type	Method and Description
Metric	addMetric(String metricName) Adds a metric to the builder.
Metric	addMetric(String metricName, String registeredType) Adds a metric to the builder with a customer type.
String	build() Returns the JSON string built by the builder.
static MetricBuilder	getInstance() Returns a new metric builder.
List<Metric>	getMetrics() Returns a list of metrics added to the builder.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static MetricBuilder getInstance()

Returns a new metric builder.

Returns:

metric builder

addMetric

public Metric addMetric(String metricName)

Adds a metric to the builder.

Parameters:

metricName - metric name

Returns:

the new metric

addMetric

public Metric addMetric(String metricName,
               String registeredType)

Adds a metric to the builder with a customer type.

Parameters:

metricName - metric name

registeredType - type used to deserialize the json on the server

Returns:

the new metric

getMetrics

public List<Metric> getMetrics()

Returns a list of metrics added to the builder.

Returns:

list of metrics

build

public String build()
             throws IOException

Returns the JSON string built by the builder. This is the JSON that can be used by the client add metrics.

Returns:

JSON

Throws:

IOException - if metrics cannot be converted to JSON