Package co.arago.hiro.client.rest

Class GraphAPI.GetHistoryCommand

java.lang.Object

co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetHistoryCommand,DefaultHiroItemListMessage>

co.arago.hiro.client.rest.GraphAPI.GetHistoryCommand

Enclosing class:

GraphAPI

public class GraphAPI.GetHistoryCommand
extends AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetHistoryCommand,DefaultHiroItemListMessage>

get the history of an entity (vertex / edge)

API GET /api/graph/[version]/{ogit/_id}/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	GetHistoryCommand(java.lang.String ogitId)

Method Summary

Modifier and Type	Method	Description
DefaultHiroItemListMessage	execute()
protected GraphAPI.GetHistoryCommand	self()
GraphAPI.GetHistoryCommand	setFrom(long from)
GraphAPI.GetHistoryCommand	setIncludeDeleted(boolean includeDeleted)
GraphAPI.GetHistoryCommand	setLimit(java.lang.Integer limit)
GraphAPI.GetHistoryCommand	setListMeta(boolean listMeta)
GraphAPI.GetHistoryCommand	setOffset(java.lang.Integer offset)
GraphAPI.GetHistoryCommand	setTo(long to)
GraphAPI.GetHistoryCommand	setType(java.lang.String type)
GraphAPI.GetHistoryCommand	setVersion(java.lang.Integer version)
GraphAPI.GetHistoryCommand	setVid(java.lang.String vid)

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

GetHistoryCommand

protected GetHistoryCommand(java.lang.String ogitId)

Parameters:

ogitId - ogit/_id of the vertex.

Method Detail

setIncludeDeleted

public GraphAPI.GetHistoryCommand setIncludeDeleted(boolean includeDeleted)

Parameters:

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

Returns:

this

setFrom

public GraphAPI.GetHistoryCommand setFrom(long from)

Parameters:

from - timestamp in ms where to start returning entries

Returns:

this

setTo

public GraphAPI.GetHistoryCommand setTo(long to)

Parameters:

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

Returns:

this

setLimit

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

Parameters:

limit - limit of entries to return

Returns:

this

setOffset

public GraphAPI.GetHistoryCommand setOffset(java.lang.Integer offset)

Parameters:

offset - offset where to start returning entries

Returns:

this

setListMeta

public GraphAPI.GetHistoryCommand setListMeta(boolean listMeta)

Parameters:

listMeta - return list type attributes with metadata

Returns:

this

setType

public GraphAPI.GetHistoryCommand setType(java.lang.String type)

Parameters:

type - response format:

• full - full event
• element - only event body
• diff - diff to previous event

Returns:

this

setVersion

public GraphAPI.GetHistoryCommand setVersion(java.lang.Integer version)

Parameters:

version - get entry with specific ogit/_v value

Returns:

this

setVid

public GraphAPI.GetHistoryCommand setVid(java.lang.String vid)

Parameters:

vid - get specific version of Entity matching ogit/_v-id

Returns:

this

self

protected GraphAPI.GetHistoryCommand self()

Specified by:

self in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetHistoryCommand,DefaultHiroItemListMessage>

execute

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

Specified by:

execute in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetHistoryCommand,DefaultHiroItemListMessage>

Returns:

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