Package co.arago.hiro.client.rest

Class GraphAPI.GetTimeseriesHistoryCommand

java.lang.Object

co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetTimeseriesHistoryCommand,HiroMessage>

co.arago.hiro.client.rest.GraphAPI.GetTimeseriesHistoryCommand

Enclosing class:

GraphAPI

public class GraphAPI.GetTimeseriesHistoryCommand
extends AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetTimeseriesHistoryCommand,HiroMessage>

get timeseries history of an entity (vertex / edge)

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

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	GetTimeseriesHistoryCommand(java.lang.String ogitId, long timestamp)

Method Summary

Modifier and Type	Method	Description
HiroMessage	execute()
protected GraphAPI.GetTimeseriesHistoryCommand	self()
GraphAPI.GetTimeseriesHistoryCommand	setIncludeDeleted(boolean includeDeleted)

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

GetTimeseriesHistoryCommand

protected GetTimeseriesHistoryCommand(java.lang.String ogitId,
                                      long timestamp)

Parameters:

ogitId - ogit/_id of the vertex.

timestamp - Timestamp in ms.

Method Detail

setIncludeDeleted

public GraphAPI.GetTimeseriesHistoryCommand setIncludeDeleted(boolean includeDeleted)

Parameters:

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

Returns:

this

self

protected GraphAPI.GetTimeseriesHistoryCommand self()

Specified by:

self in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetTimeseriesHistoryCommand,HiroMessage>

execute

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

Specified by:

execute in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetTimeseriesHistoryCommand,HiroMessage>

Returns:

A HiroMessage 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.