net.opentsdb.core

Class TSSubQuery

java.lang.Object

net.opentsdb.core.TSSubQuery

public final class TSSubQuery
extends Object

Represents the parameters for an individual sub query on a metric or specific timeseries. When setting up a query, use the setter methods to store user information such as the start time and list of queries. After setting the proper values, add the sub query to a TSQuery.

When the query is processed by the TSD, if the tsuids list has one or more timeseries, the metric and tags fields will be ignored and only the tsuids processed.

Note: You do not need to call validateAndSetQuery() directly as the TSQuery object will call this for you when the entire set of queries has been compiled. Note: If using POJO deserialization, make sure to avoid setting the agg, downsampler and downsample_interval fields.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
TSSubQuery() Default constructor necessary for POJO de/serialization

Method Summary

Methods

Modifier and Type	Method and Description
Aggregator	aggregator()
long	downsampleInterval()
Aggregator	downsampler()
String	getAggregator()
String	getDownsample()
String	getMetric()
boolean	getRate()
RateOptions	getRateOptions()
Map<String,String>	getTags()
List<String>	getTsuids()
void	setAggregator(String aggregator)
void	setDownsample(String downsample)
void	setMetric(String metric)
void	setRate(boolean rate)
void	setRateOptions(RateOptions options)
void	setTags(HashMap<String,String> tags)
void	setTsuids(List<String> tsuids)
String	toString()
void	validateAndSetQuery() Runs through query parameters to make sure it's a valid request.

Methods inherited from class java.lang.Object

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

Constructor Detail

TSSubQuery

public TSSubQuery()

Default constructor necessary for POJO de/serialization

Method Detail

toString

public String toString()

Overrides:

toString in class Object

validateAndSetQuery

public void validateAndSetQuery()

Runs through query parameters to make sure it's a valid request. This includes parsing the aggregator, downsampling info, metrics, tags or timeseries and setting the local parsed fields needed by the TSD for proper execution. If no exceptions are thrown, the query is considered valid. Note: You do not need to call this directly as it will be executed by the TSQuery object the sub query is assigned to.

Throws:

IllegalArgumentException - if something is wrong with the query

aggregator

public Aggregator aggregator()

Returns:

the parsed aggregation function

downsampler

public Aggregator downsampler()

Returns:

the parsed downsampler aggregation function

downsampleInterval

public long downsampleInterval()

Returns:

the parsed downsample interval in seconds

getAggregator

public String getAggregator()

Returns:

the user supplied aggregator

getMetric

public String getMetric()

Returns:

the user supplied metric

getTsuids

public List<String> getTsuids()

Returns:

the user supplied list of TSUIDs

getTags

public Map<String,String> getTags()

Returns:

the user supplied list of query tags, may be empty

getDownsample

public String getDownsample()

Returns:

the raw downsampling function request from the user, e.g. "1h-avg"

getRate

public boolean getRate()

Returns:

whether or not the user requested a rate conversion

getRateOptions

public RateOptions getRateOptions()

Returns:

options to use for rate calculations

setAggregator

public void setAggregator(String aggregator)

Parameters:

aggregator - the name of an aggregation function

setMetric

public void setMetric(String metric)

Parameters:

metric - the name of a metric to fetch

setTsuids

public void setTsuids(List<String> tsuids)

Parameters:

tsuids - a list of timeseries UIDs as hex encoded strings to fetch

setTags

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

Parameters:

tags - an optional list of tags for specificity or grouping

setDownsample

public void setDownsample(String downsample)

Parameters:

downsample - the downsampling function to use, e.g. "2h-avg"

setRate

public void setRate(boolean rate)

Parameters:

rate - whether or not the result should be rate converted

setRateOptions

public void setRateOptions(RateOptions options)

Parameters:

options - Options to set when calculating rates