Package co.arago.hiro.client.rest

Class GraphAPI.UpdateEntityCommand

java.lang.Object

co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf<T,R>

co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf<GraphAPI.UpdateEntityCommand,HiroVertexMessage>

co.arago.hiro.client.rest.GraphAPI.UpdateEntityCommand

Enclosing class:

GraphAPI

public class GraphAPI.UpdateEntityCommand
extends AuthenticatedAPIHandler.SendBodyAPIRequestConf<GraphAPI.UpdateEntityCommand,HiroVertexMessage>

update vertex entity by ogit/_id.

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

See Also:

API Documentation

Field Summary

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	UpdateEntityCommand(java.lang.String ogitId)
protected	UpdateEntityCommand(java.util.Map<java.lang.String,java.lang.Object> attributes)

Method Summary

Modifier and Type	Method	Description
HiroVertexMessage	execute()
protected GraphAPI.UpdateEntityCommand	self()
GraphAPI.UpdateEntityCommand	setFullResponse(boolean fullResponse)
GraphAPI.UpdateEntityCommand	setListMeta(boolean listMeta)

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

UpdateEntityCommand

protected UpdateEntityCommand(java.lang.String ogitId)

Parameters:

ogitId - ogit/_id of the vertex.

UpdateEntityCommand

protected UpdateEntityCommand(java.util.Map<java.lang.String,java.lang.Object> attributes)

Parameters:

attributes - The complete entity data. Map 'attributes' needs to contain a key "ogit/_id" with a non-blank value.

Method Detail

setFullResponse

public GraphAPI.UpdateEntityCommand setFullResponse(boolean fullResponse)

Parameters:

fullResponse - return full Entity after update is applied (default returns only metadata)

Returns:

this

setListMeta

public GraphAPI.UpdateEntityCommand setListMeta(boolean listMeta)

Parameters:

listMeta - return list type attributes with metadata

Returns:

this

self

protected GraphAPI.UpdateEntityCommand self()

Specified by:

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

execute

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

Specified by:

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