Package co.arago.hiro.client.rest

Class GraphAPI.DeleteEntityCommand

java.lang.Object

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

co.arago.hiro.client.rest.GraphAPI.DeleteEntityCommand

Enclosing class:

GraphAPI

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

delete entity by ogit/_id (vertex or edge).

API DELETE /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	DeleteEntityCommand(java.lang.String ogitId)

Method Summary

Modifier and Type	Method	Description
HiroVertexMessage	execute()
protected GraphAPI.DeleteEntityCommand	self()

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

DeleteEntityCommand

protected DeleteEntityCommand(java.lang.String ogitId)

Parameters:

ogitId - ogit/_id of the vertex.

Method Detail

self

protected GraphAPI.DeleteEntityCommand self()

Specified by:

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

execute

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

Specified by:

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