org.kairosdb.client

Interface Client

All Known Implementing Classes:

AbstractClient, HttpClient

public interface Client

Method Summary

Modifier and Type	Method and Description
RollupResponse	createRollup(RollupBuilder builder)
Response	delete(QueryBuilder builder) Deletes data in KairosDB using the query built by the builder.
Response	deleteMetric(String name) Deletes a metric.
Response	deleteRollup(String id)
Class	getDataPointValueClass(String groupType) Returns the data point value class for the given group type or null if one is not registered for the group type
GetResponse	getMetricNames() Returns a list of all metric names.
int	getRetryCount() Returns the number of retries.
RollupResponse	getRollupTask(String id)
RollupResponse	getRollupTasks()
GetResponse	getStatus() Returns status of Kairos Instance.
GetResponse	getTagNames() Returns a list of all tag names.
GetResponse	getTagValues() Returns a list of all tag values.
Response	pushMetrics(MetricBuilder builder) Sends metrics from the builder to the KairosDB server.
QueryResponse	query(QueryBuilder builder) Queries KairosDB using the query built by the builder.
QueryTagResponse	queryTag(QueryTagBuilder builder) Queries KairosDB tags using the query built by the builder.
void	registerCustomDataType(String groupType, Class dataPointValueClass) Registers a new custom data type.
void	shutdown() Shuts down the client.

Method Detail

createRollup

RollupResponse createRollup(RollupBuilder builder)
                     throws IOException

Throws:

IOException

deleteRollup

Response deleteRollup(String id)
               throws IOException

Throws:

IOException

getRollupTasks

RollupResponse getRollupTasks()
                       throws IOException

Throws:

IOException

getRollupTask

RollupResponse getRollupTask(String id)
                      throws IOException

Throws:

IOException

getMetricNames

GetResponse getMetricNames()
                    throws IOException

Returns a list of all metric names.

Returns:

list of all metric names

Throws:

IOException - if the JSON returned could not be properly processed

getTagNames

GetResponse getTagNames()
                 throws IOException

Returns a list of all tag names.

Returns:

list of all tag names

Throws:

IOException - if the JSON returned could not be properly processed

getTagValues

GetResponse getTagValues()
                  throws IOException

Returns a list of all tag values.

Returns:

list of all tag values

Throws:

IOException - if the JSON returned could not be properly processed

getStatus

GetResponse getStatus()
               throws IOException

Returns status of Kairos Instance.

Returns:

status of Kairos instance

Throws:

IOException - if the JSON returned could not be properly processed

query

QueryResponse query(QueryBuilder builder)
             throws URISyntaxException,
                    IOException

Queries KairosDB using the query built by the builder.

Parameters:

builder - query builder

Returns:

response from the server

Throws:

URISyntaxException - if the host or post is invalid

IOException - problem occurred querying the server

queryTag

QueryTagResponse queryTag(QueryTagBuilder builder)
                   throws URISyntaxException,
                          IOException

Queries KairosDB tags using the query built by the builder.

Parameters:

builder - query tag builder

Returns:

response from the server

Throws:

URISyntaxException - if the host or post is invalid

IOException - problem occurred querying the server

pushMetrics

Response pushMetrics(MetricBuilder builder)
              throws URISyntaxException,
                     IOException

Sends metrics from the builder to the KairosDB server.

Parameters:

builder - metrics builder

Returns:

response from the server

Throws:

URISyntaxException - if the host or post is invalid

IOException - problem occurred sending to the server

deleteMetric

Response deleteMetric(String name)
               throws IOException

Deletes a metric. This is the metric and all its data points.

Parameters:

name - the metric to delete

Returns:

response from the server

Throws:

IOException - problem occurred sending to the server

delete

Response delete(QueryBuilder builder)
         throws URISyntaxException,
                IOException

Deletes data in KairosDB using the query built by the builder.

Parameters:

builder - query builder

Returns:

response from the server

Throws:

URISyntaxException - if the host or post is invalid

IOException - problem occurred querying the server

getRetryCount

int getRetryCount()

Returns the number of retries.

Returns:

number of retries

shutdown

void shutdown()
       throws IOException

Shuts down the client. Should be called when done using the client.

Throws:

IOException - if could not shutdown the client

registerCustomDataType

void registerCustomDataType(String groupType,
                            Class dataPointValueClass)

Registers a new custom data type. The assumption is that this data type already exists on the server. The dataPointValueClass is used to serialize and deserialize the custom type. This is simply a POJO.

Parameters:

groupType - type used to deserialize the json on the client

dataPointValueClass - class that is the value of a data point

getDataPointValueClass

Class getDataPointValueClass(String groupType)

Returns the data point value class for the given group type or null if one is not registered for the group type

Parameters:

groupType - group type

Returns:

data point class associated with the group type