Package org.kairosdb.client.builder

Class QueryBuilder

java.lang.Object

org.kairosdb.client.builder.AbstractQueryBuilder<QueryBuilder>

org.kairosdb.client.builder.QueryBuilder

public class QueryBuilder
extends AbstractQueryBuilder<QueryBuilder>

Builder used to create the JSON to query KairosDB.

The query returns the data points for the given metrics for the specified time range. The time range can be specified as absolute or relative. Absolute times are a given point in time. Relative times are relative to now. The end time is not required and defaults to now.

For example, if you specify a relative start time of 30 minutes, all matching data points for the last 30 minutes will be returned. If you specify a relative start time of 30 minutes and a relative end time of 10 minutes, then all matching data points that occurred between the last 30 minutes up to and including the last 10 minutes are returned.

Method Summary

Modifier and Type	Method	Description
QueryMetric	addMetric(String name)	The metric to query for.
QueryMetric	addMetric(QueryMetric metric)	Adds a QueryMetric object to the QueryBuilder
protected com.google.gson.Gson	buildGson()	Builds Gson used by this implementation
boolean	equals(Object o)
int	getCacheTime()	Returns the cache time.
static QueryBuilder	getInstance()	Returns a new query builder.
List<QueryMetric>	getMetrics()	Returns the list metrics to query for.
TimeZone	getTimeZone()	Returns the time zone.
int	hashCode()
QueryBuilder	setCacheTime(int cacheTime)	How long to cache this exact query.
QueryBuilder	setTimeZone(TimeZone timeZone)
String	toString()

Methods inherited from class org.kairosdb.client.builder.AbstractQueryBuilder

build, getEndAbsolute, getEndRelative, getStartAbsolute, getStartRelative, setEnd, setEnd, setStart, setStart

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

buildGson

protected com.google.gson.Gson buildGson()

Description copied from class: AbstractQueryBuilder

Builds Gson used by this implementation

Specified by:

buildGson in class AbstractQueryBuilder<QueryBuilder>

setCacheTime

public QueryBuilder setCacheTime(int cacheTime)

How long to cache this exact query. The default is to never cache.

Parameters:

cacheTime - cache time in milliseconds

Returns:

the builder

addMetric

public QueryMetric addMetric(QueryMetric metric)

Adds a QueryMetric object to the QueryBuilder

Parameters:

metric - a QueryMetric object

Returns:

the builder

getInstance

public static QueryBuilder getInstance()

Returns a new query builder.

Returns:

new query builder

addMetric

public QueryMetric addMetric(String name)

The metric to query for.

Parameters:

name - metric name

Returns:

the builder

getCacheTime

public int getCacheTime()

Returns the cache time.

Returns:

cache time

getMetrics

public List<QueryMetric> getMetrics()

Returns the list metrics to query for.

Returns:

metrics

getTimeZone

public TimeZone getTimeZone()

Returns the time zone. The default time zone is UTC.

Returns:

time zone

setTimeZone

public QueryBuilder setTimeZone(TimeZone timeZone)

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractQueryBuilder<QueryBuilder>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractQueryBuilder<QueryBuilder>

toString

public String toString()

Overrides:

toString in class Object