net.opentsdb.core

Class IncomingDataPoint

java.lang.Object

net.opentsdb.core.IncomingDataPoint

public class IncomingDataPoint
extends Object

Bridging class that stores a normalized data point parsed from the "put" RPC methods and gets it ready for storage. Also has some helper methods that were formerly in the Tags class for parsing values.

The data point value is a string in order to accept a wide range of values including floating point and scientific. Before storage, the value will be parsed to the appropriate numeric type.

Note the class is not marked as final since some serializers may want to overload with their own fields or parsing methods.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
IncomingDataPoint() Empty constructor necessary for some de/serializers
IncomingDataPoint(String tsuid, long timestamp, String value) Constructor used when working with tsuids
IncomingDataPoint(String metric, long timestamp, String value, HashMap<String,String> tags) Constructor used when working with a metric and tags

Method Summary

Methods

Modifier and Type	Method and Description
String	getMetric()
HashMap<String,String>	getTags()
long	getTimestamp()
String	getTSUID()
String	getValue()
void	setMetric(String metric)
void	setTags(HashMap<String,String> tags)
void	setTimestamp(long timestamp)
void	setTSUID(String tsuid)
void	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IncomingDataPoint

public IncomingDataPoint()

Empty constructor necessary for some de/serializers

IncomingDataPoint

public IncomingDataPoint(String metric,
                 long timestamp,
                 String value,
                 HashMap<String,String> tags)

Constructor used when working with a metric and tags

Parameters:

metric - The metric name

timestamp - The Unix epoch timestamp

value - The value as a string

tags - The tag name/value map

IncomingDataPoint

public IncomingDataPoint(String tsuid,
                 long timestamp,
                 String value)

Constructor used when working with tsuids

Parameters:

tsuid - The TSUID

timestamp - The Unix epoch timestamp

value - The value as a string

Method Detail

toString

public String toString()

Overrides:

toString in class Object

Returns:

information about this object

getMetric

public final String getMetric()

Returns:

the metric

getTimestamp

public final long getTimestamp()

Returns:

the timestamp

getValue

public final String getValue()

Returns:

the value

getTags

public final HashMap<String,String> getTags()

Returns:

the tags

getTSUID

public final String getTSUID()

Returns:

the TSUID

setMetric

public final void setMetric(String metric)

Parameters:

metric - the metric to set

setTimestamp

public final void setTimestamp(long timestamp)

Parameters:

timestamp - the timestamp to set

setValue

public final void setValue(String value)

Parameters:

value - the value to set

setTags

public final void setTags(HashMap<String,String> tags)

Parameters:

tags - the tags to set

setTSUID

public final void setTSUID(String tsuid)

Parameters:

tsuid - the TSUID to set