Package co.arago.hiro.client.rest

Class GraphAPI.QueryTimeseriesCommand

java.lang.Object

co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf<T,R>

co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf<T,R>

co.arago.hiro.client.rest.GraphAPI.QueryBodyConf<GraphAPI.QueryTimeseriesCommand,HiroVertexListMessage>

co.arago.hiro.client.rest.GraphAPI.QueryTimeseriesCommand

Enclosing class:

GraphAPI

public class GraphAPI.QueryTimeseriesCommand
extends GraphAPI.QueryBodyConf<GraphAPI.QueryTimeseriesCommand,HiroVertexListMessage>

query timeseries values

API POST /api/graph/[version]/query/values

See Also:

API Documentation

Field Summary

Fields inherited from class co.arago.hiro.client.rest.GraphAPI.QueryBodyConf

bodyMap

Fields inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf

body

Fields inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf

fragment, headers, httpRequestTimeout, maxRetries, path, query

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueryTimeseriesCommand(java.lang.String query)

Method Summary

Modifier and Type	Method	Description
HiroVertexListMessage	execute()
protected GraphAPI.QueryTimeseriesCommand	self()
GraphAPI.QueryTimeseriesCommand	setAggregate(java.lang.String aggregate)
GraphAPI.QueryTimeseriesCommand	setFrom(long from)
GraphAPI.QueryTimeseriesCommand	setLimit(java.lang.Integer limit)
GraphAPI.QueryTimeseriesCommand	setOrder(java.lang.String order)
GraphAPI.QueryTimeseriesCommand	setTo(long to)

Methods inherited from class co.arago.hiro.client.rest.GraphAPI.QueryBodyConf

addToBody, createBody, setFields, setIncludeDeleted, setListMeta

Methods inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf

setBody, setJsonBodyFromMap, setJsonBodyFromMessage

Methods inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf

setHttpHeaders, setHttpRequestTimeout, setMaxRetries, setUrlFragment, setUrlQuery

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryTimeseriesCommand

protected QueryTimeseriesCommand(java.lang.String query)

Parameters:

query - The actual query. e.g. ogit\/name:"my timeseries name" for vertices.

Method Detail

setFrom

public GraphAPI.QueryTimeseriesCommand setFrom(long from)

Parameters:

from - timestamp in ms where to start returning entries (default: now - 1 hour)

Returns:

this

setTo

public GraphAPI.QueryTimeseriesCommand setTo(long to)

Parameters:

to - timestamp in ms where to end returning entries (default: now)

Returns:

this

setLimit

public GraphAPI.QueryTimeseriesCommand setLimit(java.lang.Integer limit)

Parameters:

limit - limit of entries to return

Returns:

this

setOrder

public GraphAPI.QueryTimeseriesCommand setOrder(java.lang.String order)

Parameters:

order - order by a timestamp asc|desc|none

Returns:

this

setAggregate

public GraphAPI.QueryTimeseriesCommand setAggregate(java.lang.String aggregate)

Parameters:

aggregate - aggregate numeric values for multiple timeseries ids with same timestamp: avg|min|max|sum|none

Returns:

this

self

protected GraphAPI.QueryTimeseriesCommand self()

Specified by:

self in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.QueryTimeseriesCommand,HiroVertexListMessage>

execute

public HiroVertexListMessage execute()
                              throws HiroException,
                                     java.io.IOException,
                                     java.lang.InterruptedException

Specified by:

execute in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.QueryTimeseriesCommand,HiroVertexListMessage>

Returns:

HiroVertexListMessage The Json Response

Throws:

HiroException - When the call returns a http status error.

java.io.IOException - When the call got an IO error.

java.lang.InterruptedException - When the call gets interrupted.