org.gecko.influxdb.api

Interface InfluxDBEntry

All Known Implementing Classes:

InfluxDBEntryImpl

public interface InfluxDBEntry

This interface allows to set up an InfluxDBEntry to be used to write points in an InfluxDB through the InfluxDBService.

Since:

May 3, 2019

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getFields()
java.lang.Object	getMeasurement()
java.util.Map<java.lang.String,java.lang.String>	getTags()
long	getTimestamp()
void	setMeasurement(java.lang.Object object) Sets the measurement for the InfluxDBEntry which will be used to create a Point in the db.
void	setTimestamp(long timestamp) Sets the timestamp associated with the measurement in this InfluxDBEntry The timestamp unit is milliseconds.

Method Detail

getFields

java.util.Map<java.lang.String,java.lang.Object> getFields()

Returns:

the list of fields for the InfluxDBEntry which will be used to create a Point in the db. At least one filed has to be provided.

getTags

java.util.Map<java.lang.String,java.lang.String> getTags()

Returns:

the list of tags for the InfluxDBEntry which will be used to create a Point in the db. The tags are optional.

getMeasurement

java.lang.Object getMeasurement()

Returns:

the measurement for the InfluxDBEntry which will be used to create a Point in the db. *

setMeasurement

void setMeasurement(java.lang.Object object)

Sets the measurement for the InfluxDBEntry which will be used to create a Point in the db. This is a mandatory field. Current implementation expects a String.

Parameters:

object - the measurement to be set

getTimestamp

long getTimestamp()

Returns:

the timestamp associated with the measurement in this InfluxDBEntry.

setTimestamp

void setTimestamp(long timestamp)

Sets the timestamp associated with the measurement in this InfluxDBEntry The timestamp unit is milliseconds. If no timestamp is provided the Point will be saved in the DB with the timestamp at the time of the saving operation.

Parameters:

timestamp -