Package co.arago.hiro.client.rest

Class GraphAPI.GetEntityCommand

java.lang.Object

co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetEntityCommand,HiroVertexMessage>

co.arago.hiro.client.rest.GraphAPI.GetEntityCommand

Enclosing class:

GraphAPI

public class GraphAPI.GetEntityCommand
extends AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetEntityCommand,HiroVertexMessage>

get entity by ogit/_id (vertex or edge)

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

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	GetEntityCommand(java.lang.String ogitId)

Method Summary

Modifier and Type	Method	Description
HiroVertexMessage	execute()
protected GraphAPI.GetEntityCommand	self()
GraphAPI.GetEntityCommand	setFields(java.lang.String fields)
GraphAPI.GetEntityCommand	setIncludeDeleted(boolean includeDeleted)
GraphAPI.GetEntityCommand	setListMeta(boolean listMeta)
GraphAPI.GetEntityCommand	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

GetEntityCommand

protected GetEntityCommand(java.lang.String ogitId)

Parameters:

ogitId - ogit/_id of the entity. This can be a vertex id or a composed edge id.

Method Detail

setFields

public GraphAPI.GetEntityCommand setFields(java.lang.String fields)

Parameters:

fields - the comma separated list of fields to return

Returns:

this

setIncludeDeleted

public GraphAPI.GetEntityCommand setIncludeDeleted(boolean includeDeleted)

Parameters:

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

Returns:

this

setListMeta

public GraphAPI.GetEntityCommand setListMeta(boolean listMeta)

Parameters:

listMeta - return list type attributes with metadata

Returns:

this

setVid

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

Parameters:

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

Returns:

this

self

protected GraphAPI.GetEntityCommand self()

Specified by:

self in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetEntityCommand,HiroVertexMessage>

execute

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

Specified by:

execute in class AuthenticatedAPIHandler.APIRequestConf<GraphAPI.GetEntityCommand,HiroVertexMessage>

Returns:

HiroVertexMessage 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.