Package co.arago.hiro.client.rest

Class GraphAPI.GetTimeseriesCommand

java.lang.Object

co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetTimeseriesCommand,HiroTimeseriesListMessage>

co.arago.hiro.client.rest.GraphAPI.GetTimeseriesCommand

Enclosing class:

GraphAPI

public class GraphAPI.GetTimeseriesCommand
extends AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetTimeseriesCommand,HiroTimeseriesListMessage>

get timeseries of an entity (vertex / edge)

API GET /api/graph/[version]/{ogit/_id}/values

See Also:

API Documentation

Field Summary

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

fragment, headers, httpRequestTimeout, maxRetries, path, query

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GetTimeseriesCommand(java.lang.String ogitId)

Method Summary

Modifier and Type	Method	Description
HiroTimeseriesListMessage	execute()
protected GraphAPI.GetTimeseriesCommand	self()
GraphAPI.GetTimeseriesCommand	setAggregate(java.lang.String aggregate)
GraphAPI.GetTimeseriesCommand	setFrom(long from)
GraphAPI.GetTimeseriesCommand	setIncludeDeleted(boolean includeDeleted)
GraphAPI.GetTimeseriesCommand	setLimit(java.lang.Integer limit)
GraphAPI.GetTimeseriesCommand	setOrder(java.lang.String order)
GraphAPI.GetTimeseriesCommand	setTo(long to)
GraphAPI.GetTimeseriesCommand	setWith(java.lang.String with)

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

GetTimeseriesCommand

protected GetTimeseriesCommand(java.lang.String ogitId)

Parameters:

ogitId - ogit/_id of the vertex.

Method Detail

setIncludeDeleted

public GraphAPI.GetTimeseriesCommand setIncludeDeleted(boolean includeDeleted)

Parameters:

includeDeleted - allow getting if ogit/_is-deleted=true

Returns:

this

setFrom

public GraphAPI.GetTimeseriesCommand setFrom(long from)

Parameters:

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

Returns:

this

setTo

public GraphAPI.GetTimeseriesCommand setTo(long to)

Parameters:

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

Returns:

this

setLimit

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

Parameters:

limit - limit of entries to return

Returns:

this

setOrder

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

Parameters:

order - order by a timestamp asc|desc|none

Returns:

this

setWith

public GraphAPI.GetTimeseriesCommand setWith(java.lang.String with)

Parameters:

with - csv list of ids to aggregate in result

Returns:

this

setAggregate

public GraphAPI.GetTimeseriesCommand 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.GetTimeseriesCommand self()

Specified by:

self in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetTimeseriesCommand,HiroTimeseriesListMessage>

execute

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

Specified by:

execute in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetTimeseriesCommand,HiroTimeseriesListMessage>

Returns:

A HiroTimeseriesListMessage with the Json result data.

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.