Package co.arago.hiro.client.rest

Class GraphAPI.QueryByIdsCommand

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.QueryByIdsCommand,HiroVertexListMessage>

co.arago.hiro.client.rest.GraphAPI.QueryByIdsCommand

Enclosing class:

GraphAPI

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

query by ids

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

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	QueryByIdsCommand(java.lang.String ids)

Method Summary

Modifier and Type	Method	Description
HiroVertexListMessage	execute()
protected GraphAPI.QueryByIdsCommand	self()

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

QueryByIdsCommand

protected QueryByIdsCommand(java.lang.String ids)

Parameters:

ids - The comma separated list of ids, e.g. id1,id2,id3

Method Detail

self

protected GraphAPI.QueryByIdsCommand self()

Specified by:

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

execute

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

Specified by:

execute in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.QueryByIdsCommand,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.