QueryBuilder (kairosclient 2.0 API)

java.lang.Object
- org.kairosdb.client.builder.QueryBuilder

```
public class QueryBuilder
extends Object
```
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

Methods
Modifier and Type	Method and Description
`QueryMetric`	`addMetric(String name)` The metric to query for.
`String`	`build()` Returns the JSON string built by the builder.
`int`	`getCacheTime()` Returns the cache time.
`Date`	`getEndAbsolute()` Returns the absolute range end time.
`RelativeTime`	`getEndRelative()` Returns the relative range end time.
`static QueryBuilder`	`getInstance()` Returns a new query builder.
`List<QueryMetric>`	`getMetrics()` Returns the list metrics to query for.
`Date`	`getStartAbsolute()` Returns the absolute range start time.
`RelativeTime`	`getStartRelative()` Returns the relative range start time.
`QueryBuilder`	`setCacheTime(int cacheTime)` How long to cache this exact query.
`QueryBuilder`	`setEnd(Date end)` The ending value of the time range.
`QueryBuilder`	`setEnd(int duration, TimeUnit unit)` The ending time of the time range relative to now.
`QueryBuilder`	`setStart(Date start)` The beginning time of the time range.
`QueryBuilder`	`setStart(int duration, TimeUnit unit)` The beginning time of the time range relative to now.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setStart
```
public QueryBuilder setStart(Date start)
```
    The beginning time of the time range.
    
    Parameters:
    start - start time
    
    Returns:
    the builder
  - setStart
```
public QueryBuilder setStart(int duration,
                    TimeUnit unit)
```
    The beginning time of the time range relative to now. For example, return all data points that starting 2 days ago.
    
    Parameters:
    duration - relative time value
    unit - unit of time
    
    Returns:
    the builder
  - setEnd
```
public QueryBuilder setEnd(Date end)
```
    The ending value of the time range. Must be later in time than the start time. An end time is not required and default to now.
    
    Parameters:
    end - end time
    
    Returns:
    the builder
  - setEnd
```
public QueryBuilder setEnd(int duration,
                  TimeUnit unit)
```
    The ending time of the time range relative to now.
    
    Parameters:
    duration - relative time value
    unit - unit of time
    
    Returns:
    the builder
  - 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
  - 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
  - getStartAbsolute
```
public Date getStartAbsolute()
```
    Returns the absolute range start time.
    
    Returns:
    absolute range start time
  - getEndAbsolute
```
public Date getEndAbsolute()
```
    Returns the absolute range end time.
    
    Returns:
    absolute range end time
  - getStartRelative
```
public RelativeTime getStartRelative()
```
    Returns the relative range start time.
    
    Returns:
    relative range start time
  - getEndRelative
```
public RelativeTime getEndRelative()
```
    Returns the relative range end time.
    
    Returns:
    relative range end time
  - 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
  - build
```
public String build()
             throws IOException
```
    Returns the JSON string built by the builder. This is the JSON that can be used by the client to query KairosDB
    
    Returns:
    JSON
    
    Throws:
    
    IOException - if the query is invalid and cannot be converted to JSON

Class QueryBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setStart

setStart

setEnd

setEnd

setCacheTime

getInstance

addMetric

getStartAbsolute

getEndAbsolute

getStartRelative

getEndRelative

getCacheTime

getMetrics

build