org.hawkular.agent.monitor.storage

Class MetricDataPayloadBuilderImpl

java.lang.Object

org.hawkular.agent.monitor.storage.MetricDataPayloadBuilderImpl

All Implemented Interfaces:

MetricDataPayloadBuilder

public class MetricDataPayloadBuilderImpl
extends Object
implements MetricDataPayloadBuilder

Allows one to build up a payload request to send to metric storage by adding data points one by one. After all data points are added, you can get the payload in either an object format or a JSON format.

Constructor Summary

Constructors

Constructor and Description
MetricDataPayloadBuilderImpl()

Method Summary

Modifier and Type	Method and Description
void	addDataPoint(String key, long timestamp, double value, org.hawkular.metrics.client.common.MetricType metricType) Add a metric data point.
int	getNumberDataPoints()
String	getTenantId()
void	setTenantId(String tenantId) If the metric data is to be stored with a special tenant ID, this sets that tenant ID.
Map<String,List<Map<String,Object>>>	toObjectPayload()
String	toPayload()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricDataPayloadBuilderImpl

public MetricDataPayloadBuilderImpl()

Method Detail

addDataPoint

public void addDataPoint(String key,
                         long timestamp,
                         double value,
                         org.hawkular.metrics.client.common.MetricType metricType)

Description copied from interface: MetricDataPayloadBuilder

Add a metric data point. When all metric data points are added, call MetricDataPayloadBuilder.toPayload() to get the payload message that can be used to send to the storage backend via the storage adapter.

Specified by:

addDataPoint in interface MetricDataPayloadBuilder

Parameters:

key - identifies the metric

timestamp - the time the metric was collected

value - the value of the metric

metricType - the type of metric

toObjectPayload

public Map<String,List<Map<String,Object>>> toObjectPayload()

toPayload

public String toPayload()

Specified by:

toPayload in interface MetricDataPayloadBuilder

Returns:

the payload in a format suitable for the storage adapter.

getNumberDataPoints

public int getNumberDataPoints()

Specified by:

getNumberDataPoints in interface MetricDataPayloadBuilder

Returns:

the number of data points that were added to the payload

setTenantId

public void setTenantId(String tenantId)

Description copied from interface: MetricDataPayloadBuilder

If the metric data is to be stored with a special tenant ID, this sets that tenant ID. If null is passed in, or if this method is not called, the agent's tenant ID is used.

Specified by:

setTenantId in interface MetricDataPayloadBuilder

Parameters:

tenantId - the tenant ID to associate the metric data with. May be null.

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface MetricDataPayloadBuilder

Returns:

the tenant ID to be associated with the metric data. If null, the agent's tenant ID is used.